API キー
API キーの作り方・範囲(scope)・期限・作り直し。
Cloud Paper で使う鍵・トークン・コードを、どう手に入れるか/何ができるか/いつ切れるか/どう止めるか/どこに置くかで一覧にする。 新しい鍵やトークンを足すときは、必ずこの章に行を足すこと。
3.3 API キー(外のシステム向け)
外のシステムは、API キーでテナントの API(API リファレンス)を呼ぶ。
発行: パネル「API キー」で、名前・範囲(scope)・有効期限を選んで作る。キーはこの画面で一度だけ表示される。
| scope | できること |
|---|---|
full | すべて(印刷・FAX・受け口・着信・PC の承認・上限の参照) |
print | 印刷・FAX の依頼と結果の参照、印刷先の一覧 |
inbox | 受け口の品目の一覧・取得・確認 |
calls | 着信の一覧 |
upload | 受け口に書類を入れるだけ(POST /api/v1/inboxes/{name}/items。受け口の「API から受け取る」が入っているときだけ)。届いた書類は読めない。スマートフォンのアプリなどに持たせる鍵 |
どの scope でも、送信先(Webhook)の追加、PC の設定、上限の引き上げはできない(パネルのみ・PC のみ・運営のみ)。
使い方: Authorization: Bearer cpk_…。テナントのホスト以外では使えない(別のテナントのホストでは 401)。
期限・使用の記録・作り直し(実装済み)
expires_at: 既定 1 年、最長 2 年。無期限は作れない。期限の 30 日前と 7 日前に所有者・管理者へメール。last_used_atとlast_used_ip: パネルに表示(記録は 1 分に 1 回まで)。90 日使われていないキーはパネルで目立たせる。- ローテーション: 「作り直す」で新しいキーを発行し、古いキーは選んだ猶予(なし/1 時間/24 時間/7 日)のあとに失効。
- 表示用の接頭辞(
cpk_ab12…)だけを保存して一覧に出し、どのキーか見分けられるようにする。 - 監査ログ: 発行(
apikey.created)・取り消し(apikey.revoked)・ローテーション(apikey.rotated)・期限の知らせ(apikey.expiry_warning)・期限切れ(apikey.expired)を記録。 - 期限のない古い鍵は、起動のときに「作ってから 1 年」の期限を付ける。
漏れたとき: パネルで取り消す。送信先は API で足せず、PC の設定もクラウドから変えられないので、漏れたキーで外への経路は増えない。印刷できる量は、サーバーの予算と PC の上限で止まる。
ご不明な点はお問い合わせください。