API リファレンス
認証と API キー
API キーは、コンソールの「開発者」から発行します。鍵には、許す範囲と期限を付けます。
API リファレンス全 4 ページ
目次全 4 章
鍵を発行する
コンソールの「開発者」→「API キー」で発行します。発行できるのは、鍵を発行する権限を持つ管理者です。
鍵の文字列は、発行したときに一度だけ表示されます。安全な場所に保管してください。こちらでは鍵そのものを保存せず、照合用の値だけを持っています。
範囲と期限
- 範囲 — 鍵に許す権限を選んで絞るか、持ち主と同じ範囲にするかを決めます。必要な権限だけに絞ることをおすすめします。
- ブランド — 鍵で触れるブランドを決められます。
- 期限 — 1 日から 10 年の間で決めます。期限を過ぎた鍵は使えなくなります。
- 鍵に、持ち主が持っていない権限を付けることはできません。
鍵の使い方
リクエストのヘッダーに、次の形で鍵を付けます。
Authorization: Bearer <API キー>
会社を指定する必要はありません。鍵がどの会社のものかは、鍵そのものから決まります。
鍵を止める
使わなくなった鍵や、漏れたおそれのある鍵は、同じ画面ですぐに失効させてください。失効した鍵は、その時点から使えなくなります。漏れたおそれがあるときは、セキュリティの窓口にも知らせてください。