APIキーの発行と管理

API を使うには API キーが必要です。キーは 設定 > 連携 > APIキー から発行します。

発行できるのは組織の管理者（オーナーまたは管理者）だけです。店舗ごとのスタッフは発行できません。

キーを発行する

キーごとに、許可する操作を選べます。使わない操作は外してください。 万一キーが漏れたときの影響を狭められます。

顧客の検索だけ、はじめからチェックが外れています。 顧客の個人情報をまとめて取得できてしまうため、必要なときだけ選んでください。

権限が足りない操作を呼ぶと 403 が返ります。

{
  "error": "この操作には reservations:write のスコープが必要です",
  "code": "INSUFFICIENT_SCOPE"
}

キーは組織に属します。「すべての店舗」を選ぶと、組織配下のどの店舗も扱えます。

連携先が1店舗だけなら、その店舗に限定することをおすすめします。 キーが漏れたときに他の店舗のデータが読まれずに済みます。

限定したキーで別の店舗を指定すると 404 になります。

キーは同時に複数持てます。差し替えるときは次の順で行うと、連携を止めずに済みます。

発行できるのは組織あたり10本までです（失効させたものは数えません）。上限に達したら、使っていないキーを失効させてください。

一覧の「失効」から取り消せます。失効は即座に効きます。 そのキーを設定している連携はすぐに動かなくなるので、切り替えが済んでいることを確認してから行ってください。

失効させたキーは一覧に「失効済み」として残ります。いつ・誰が発行したキーが何をしたかを、あとから監査ログで辿れるようにするためです。元に戻すことはできません。

APIキーはパスワードと同じものです。

一覧に「最終利用」が表示されます。想定していないキーが使われていないか、ときどき確認してください。