レスポンスコード
Legitmark は標準の HTTP コードを使用してリクエストの成功または失敗を示します。 一般的に、2xx HTTP コードは成功、4xx コードはユーザー関連のエラー、5xx コードはインフラストラクチャの問題を示します。
すべての可能な API エラーの完全な分類についてはエラーコードを確認してください。
エラーレスポンス形式
すべてのエラーレスポンスは以下の構造に従います:エラーカテゴリ
バリデーションエラー (400)
リクエストパラメータが要件を満たさない場合にバリデーションエラーが発生します:認証エラー (401)
API キーがない場合や無効な場合に認証エラーが発生します:認可エラー (403)
API キーに必要な権限がない場合に認可エラーが発生します:未検出エラー (404)
リクエストされたリソースが存在しない場合に未検出エラーが発生します:競合エラー (409)
重複リソースの作成や制約違反時に競合エラーが発生します:サーバーエラー (5xx)
サーバーエラーは Legitmark インフラストラクチャの問題を示します:トラブルシューティング
よくある問題
400 Bad Request- すべての必須パラメータが含まれているか確認
- パラメータのタイプと形式を検証
- JSON が正しくフォーマットされていることを確認
- フィールド名が snake_case を使用しているか確認
- Authorization ヘッダーに API キーが含まれているか確認
- API キーの形式を確認:
Bearer leo_xxxxxxxxx - API キーが有効で期限切れでないことを確認
- API キーに必要な権限があるか確認
- リソースアクセスが制限されているか確認
- 権限の問題についてはサポートに連絡
- リソース ID/UUID が正しいか確認
- リソースが存在するか確認
- エンドポイント URL が正しいことを確認
- 再試行前に待機(retry-after ヘッダーを確認)
- 指数バックオフを実装
- レート制限のアップグレードを検討
- 少し待ってからリクエストを再試行
- Legitmark ステータスページを確認
- 問題が続く場合はサポートに連絡
デバッグのヒント
-
レスポンスヘッダーを確認
- Content-Type は
application/jsonであるべき - レート制限ヘッダーで現在の使用状況を確認
- サポート問い合わせ用のリクエスト ID
- Content-Type は
-
リクエスト形式を検証
- 適切な Content-Type ヘッダーを使用
- JSON 構文が有効であることを確認
- すべての必須フィールドが含まれていることを確認
-
最小限のデータでテスト
- 最もシンプルなリクエストから開始
- 徐々に複雑さを増す
- API プレイグラウンドでテスト
-
レート制限を監視
- API 使用パターンを追跡
- 適切な再試行ロジックを実装
- 必要に応じてレスポンスをキャッシュ