エラー処理

このガイドでは、k-ID APIのエラー処理について説明します。一般的なエラーコード、エラーレスポンス形式、エラー処理のベストプラクティスを含みます。

エラーレスポンス形式

すべてのAPIエラーは、一貫したレスポンス形式に従います。エラーレスポンスにはerrorフィールドとerrorMessageフィールドが含まれます：

{
  "error": "ERROR_CODE",
  "errorMessage": "人間が読めるエラーメッセージ"
}

HTTPステータスコード

k-ID APIは、標準のHTTPステータスコードを使用してAPIリクエストの結果を示します：

ステータスコード	説明	発生する場合
200	OK	リクエスト成功
400	Bad Request	無効なリクエストパラメータ
401	Unauthorized	無効または欠落しているAPIキー
429	Too Many Requests	レート制限超過
500	Internal Server Error	サーバーエラー

一般的なエラーコード

認証エラー

UNAUTHORIZED

ステータス: 401
説明: 無効または欠落しているAPIキー

{
  "error": "UNAUTHORIZED",
  "errorMessage": "Unauthorized"
}

一般的な原因:

• Authorizationヘッダーが欠落している
• 無効なAPIキー形式
• 期限切れのAPIキー

解決方法:

• APIキーが正しいことを確認する
• キーがアクティブで期限切れでないことを確認する
• Authorizationヘッダーでキーが適切にフォーマットされていることを確認する

リクエスト検証エラー

INVALID_INPUT

ステータス: 400
説明: リクエスト検証が失敗した

{
  "error": "INVALID_INPUT",
  "errorMessage": "The age verification could not be found."
}

解決方法:

• 検証エラーの詳細を確認する
• 無効なフィールド値を修正する
• 有効な値についてはAPIドキュメントを参照する

リソースエラー

レート制限エラー

ステータス: 429
説明: レート制限超過
レスポンス本文なし

解決方法:

• 指数バックオフを実装する
• リクエスト頻度を減らす
• 適切な場合にレスポンスをキャッシュする

サーバーエラー

ステータス: 500
説明: 内部サーバーエラー

{
  "error": "INTERNAL_ERROR",
  "errorMessage": "Internal server error"
}

解決方法:

• 遅延後にリクエストを再試行する
• エラーが続く場合はサポートに連絡する
• サービスステータスページを確認する

次のステップ

• APIエンドポイント - 利用可能なエンドポイントについて学ぶ
• 認証 - API認証について学ぶ