Printgraph Docs

API キー

API キーの管理方法

概要

API キー管理画面では、外部システムとの連携に使用する API キーの発行・管理を行うことができます。

機能一覧

1. API キーの発行

  1. 画面右上の 「API キー発行」 ボタンをクリック
  2. モーダルが表示されたら、API キーの名前を入力(例:「開発環境用」「本番環境用」)
  3. 「発行」 ボタンをクリック
  4. 発行された API キーが表示される
  5. コピーアイコンをクリックして キーをクリップボードにコピー
  6. 「閉じる」 ボタンでモーダルを閉じる

セキュリティ上の注意

発行された API キーは安全な場所に保管してください。キーが漏洩した場合は、即座にキーを削除し、新しいキーを発行してください。

2. API キー一覧の確認

テーブルには以下の情報が表示されます:

内容
名前API キーの識別名
API キーコピーボタンをクリックすることで、API キーをクリップボードにコピーできます。
発行日API キーを発行した日時
操作編集・削除メニュー

3. API キーの編集

  1. 編集したい API キーの行で ︙(操作メニュー) をクリック
  2. 「編集」 を選択
  3. 名前を変更して 「保存」 をクリック

※ API キーの値自体は変更できません。名前のみ変更可能です。

4. API キーの削除

  1. 削除したい API キーの行で ︙(操作メニュー) をクリック
  2. 「削除」 を選択
  3. 確認ダイアログで 「削除」 をクリック

セキュリティ上の注意

削除した API キーは復元できません。該当キーを使用しているシステムは API にアクセスできなくなります。

セキュリティに関する注意事項

  • API キーは必要最低限の関係者のみがアクセスできるように管理してください
  • 第三者に API キーを共有しないでください
  • 漏洩の可能性がある場合は、即座に該当キーを削除し、新しいキーを発行してください
  • 定期的に不要なキーを削除することを推奨します