HTTP ステータスコード
API は標準的な HTTP ステータスコードを使用します。AIヘルプデスク API はリードオンリーのため、2xx 系では 200 のみを返します。
エラーレスポンス形式
エラーが発生した場合、API は以下の形式の JSON レスポンスを返します。レスポンスフィールド
一般的なエラー
認証エラー (401)
X-API-Key ヘッダーが設定されていない、または値が無効。
リソース未存在 (404)
sessionKey、docId、typePath、integrationId など)が存在しないか、別テナントに属している。
パラメータエラー (400)
status や assigneeType などの enum パラメータに範囲外の値を指定した、limit が 1..100(procedures は 1..500)の範囲外、など。
エラー処理のベストプラクティス
- レスポンスは必ず
okフィールドの真偽で成否を判定する errorメッセージはログに記録し、ユーザーへは内容に応じて適切に翻訳して表示する- 401 はキー再発行が必要なため、自動リトライではなく運用者に通知する
- 404 は呼び出し側のロジックの問題なので、自動リトライしない
- センシティブな情報(API キー全体など)をエラーメッセージのログへ含めないようにする

