マニュアル目次 > 販促・決済・顧客

APIキー

メニュー:予約管理 > APIキー

画面の概要

外部システム(他社サービス・自社の別システムなど)とデータ連携するためのAPIキーを発行・管理する画面です。用途ごとにキーを作成し、対象店舗の限定や、読み取りのみ/書き込み許可といった権限を設定できます。

入力欄

項目意味・役割
APIキー(変更不可)編集画面でのみ表示される、発行済みのキー文字列。新規作成時は保存時に自動生成されます(この欄は編集不可)。
用途名必須連携先システム名など、キーの用途がわかる名前。
対象店舗特定の店舗に限定する場合のみ選択。未選択なら「全店舗」対象。
書き込みを許可するONにすると、このキーで予約の登録・変更・キャンセルが可能になります。OFFなら読み取りのみ。
有効にするONで利用可能。OFFで即時に無効化(連携を止めたいとき)。

補足情報

APIキーは外部へ公開される機密情報です。用途ごとに分けて発行し、書き込みが不要な連携には「書き込みを許可する」をOFFにしてください。漏えいが疑われる場合は「有効にする」をOFFにするか削除して、新しいキーを発行します。APIの仕様は開発ドキュメント(docs/api.md)を参照してください。