認証
SupDesk APIの場所:
https://api.supdesk.app/v1すべてのリクエストはAPIキーをBearerトークンとして送信して認証されます:
curl https://api.supdesk.app/v1/submissions \
-H "Authorization: Bearer sd_live_..."キーの作成
ワークスペース設定 → APIキーでキーを作成します。各キー:
- 単一のプロジェクトに限定 — それを通じて読み書きするすべてはそのプロジェクトに属します;
sd_live_のように認識しやすい接頭辞で始まります — 設定ファイルでキーを露出せずに特定できます;- 作成時に1度だけ表示されます。SupDeskはキーのハッシュのみを保存します — 失くした場合は無効化して新規作成してください。
キーの取り扱い
APIキーはパスワードとして扱ってください。キーはサーバーからのみ呼び出してください — APIは意図的にCORSサポートを持たず、ブラウザでは使用できません。キーが漏洩した場合はコンソールで無効化してください;無効化は即座に効果を持ちます。
認証エラー
欠損、形式破損、無効化、または不明なキーは常に同じ応答を返します:
{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key."
}
}呼び出し側はキーの存在を推測できません。
読み取り vs. 書き込みアクセス
すべてのプランはAPI経由で読み取り可能です。書き込みエンドポイント(POST、PATCH、DELETE)は有料プラン Proが必要です — Freeでは403 forbiddenエラーを返します。レート制限と利用状況を参照ください。
Last updated on