API キーを発行する・失効させる
サーバーから avacast の API を呼ぶための API キーの発行と失効の手順です。
API キーは、お客様のサーバーから avacast の API を呼ぶときに使います。サーバーだけで使い、ブラウザーやアプリには置かないでください。発行・失効ができるのはオーナーだけです。
API キーを発行する
- 左のメニューの[API キー]を開きます。
- 「新しいキーを発行」の「名前」に、用途が分かる名前(例:本番サーバー)を入力します(100 文字まで)。
- [発行]を押します。
- 表示されたキーをコピーして、安全な場所に控えます。
- [閉じる]を押します。
キーが表示されるのはこの 1 回だけです。avacast はキーそのものを保存していないため、あとから表示することはできません。控えそこねた場合は、そのキーを失効させて新しく発行してください。
使い方(セッションの作成など)は API リファレンスの「認証」をご覧ください。
API キーを失効させる
- 「発行済みのキー」の一覧で、失効させるキーの[失効]を押します。
- 確認の画面で[失効させる]を押します。
失効させたキーは元に戻せません。そのキーを使っているシステムは、すぐに API を呼べなくなります。キーを入れ替える場合は、新しいキーを発行してシステムに設定してから、古いキーを失効させてください。失効させたキーは一覧に表示されません。
一覧の見方
「キー」にはキーの先頭の数文字だけを表示します。「最終利用」で、そのキーが最後に使われた日時を確認できます。使われていないキーは失効させることをおすすめします。