APIキー・API連携オプション

/orgs/{orgId}/api-keysで、SISA公開API(External API)へアクセスするためのAPIキーを発行・管理します。Basic・Team・Business のプランで利用できます(Lite では利用できません)。

API利用オプションとキー発行の関係

APIキーの発行・失効はセキュリティ上の操作、API利用オプション(月額¥2,500)の契約・解約は課金上の操作として、意図的に別々の操作として扱われています。

• 最初のAPIキーを発行すると、API利用オプションが自動的に有効化されます(別途申し込み手続きは不要)
• キーを1本失効させても、他にキーが残っていればAPI利用オプションの課金は継続します
• 「API利用オプションを解約」を実行すると、現在の請求期間の終わりまでは利用でき、期間終了時に発行済みのキーがすべて失効します。解約後も期間終了前であれば「解約を取り消す(再有効化)」ができます

APIキーを発行する

「発行」から、キー名(用途がわかる名前。例: 「社内ダッシュボード連携」)と権限(読み取り専用/ 読み取り・書き込み)を指定します。用途ごとにキーを分けておくと、権限の管理や必要になったときの失効がしやすくなります。

発行直後の画面にのみ、キーの値がそのまま表示されます。「クリップボードにコピーする」で控えておいてください。一覧に戻ると、以後この値を再表示することはできません。

キーを再生成・失効する

一覧の各キーから「再生成」(値だけを新しくして権限・キー名は維持)、または「失効する」(そのキーを完全に無効化)ができます。失効は取り消せません。