APIキーを発行する

APIキーを発行する

外部のシステムやツールからジョブを実行する際に必要なAPIキーを発行できます。

1. 管理画面にログインする
2. 画面右上のユーザー名から「アカウント情報」をクリックする
   
3. APIキーの「新規作成」ボタンをクリックする
   

4. 以下の項目を入力し、「作成」ボタンをクリックする
   

   項目	説明
   名称	APIキーの名前を入力してください。 ※1〜100文字で入力してください。同じ名前のキーが複数あっても問題ありません。
   説明	APIキーの説明を入力してください。 ※0〜500文字で入力できます。用途や連携先などを書いておくと管理しやすくなります。

5. APIキーを発行すると、画面にAPIキーの値が表示されます

   注意点

   キーの値は発行直後の画面でしか確認できません。必ずこの時点でコピーして、安全な場所に保管してください。
   画面を閉じると、以降は値を再表示することができません。

   

APIキーの上限について

1アカウントあたり、有効なAPIキーは最大10件まで発行できます。
10件に達すると「新規作成」ボタンが非活性になり、上限に達した旨のメッセージがツールチップで表示されます。新しいキーが必要な場合は、不要なキーを先に無効化してください。

APIキーの一覧を確認する

管理画面の「アカウント情報」から、自分が発行したAPIキーの一覧を確認できます。
一覧に表示される情報は以下のとおりです。

APIキーを削除する

不要になったAPIキーの削除は、以下の手順で行ってください。

1. APIキーの一覧画面を開く
2. 無効化したいキーの 「削除」ボタンをクリックする
3. 内容を確認して「delete」と入力する
4. 「削除」ボタンをクリックし無効化を実行します。
   ※無効化したキーは即座に使えなくなり、復元できません。他のキーには影響しません。

キーの値を紛失・忘れてしまった場合

キーの値は発行直後以外に確認する方法がありません。紛失・失念した場合は以下の手順で対応してください。

1. 対象のキーを無効化する
2. 必要に応じて、新しいAPIキーを発行する