認証
Platform API へのすべてのリクエストに、次の 2 つのヘッダーが必要です。
| ヘッダー | 必須 | 用途 |
|---|---|---|
API-Key | ✅ | 開発者コンソールで発行した API キー |
X-TenantID | ✅ | リクエストが実行される組織 (ワークスペース) の ID |
bash
curl "$ME_BASE/voice/providers" \
-H "API-Key: $ME_API_KEY" \
-H "X-TenantID: $ME_TENANT"認証情報はサーバー側に保管してください
API-Key は秘密情報です。ブラウザやモバイルアプリなど、管理下にないクライアントに埋め込まないでください。自社のバックエンド経由でリクエストしてください。
キーで到達できる範囲
キーはその所有者の権限を持ちます。リクエストはキーの所有者として、X-TenantID の組織に対して認可されます。つまりキーが到達できる範囲は所有者と同じで、それ以上ではありません。
キー自体が権限を絞るわけではありません。連携に必要な権限だけを持つアカウントでキーを発行し、漏洩した場合はすぐに再発行してください。
エラー
| ステータス | 意味 | 対処 |
|---|---|---|
401 | API-Key または X-TenantID が無いか不正 | 両方のヘッダーが存在し有効か確認します |
400 | リクエストボディが不正 | API リファレンス と照合します |
404 | 対象が見つからない | パスと ID を確認します |
