エラーハンドリング
Proctorio APIは標準のHTTPステータスコードを使用し、構造化されたエラーレスポンスを返します。
HTTPステータスコード
| コード | 意味 |
|---|---|
200 | 成功 — リクエストが完了し、URLが生成されました |
400 | 不正なリクエスト — 1つ以上のフィールドでバリデーションが失敗しました |
401 | 未認証 — APIキーが無効または欠落しています |
429 | リクエスト過多 — レート制限を超過しました |
500 | サーバーエラー — 内部エラー、指数バックオフで再試行してください |
エラーレスポンスの形式
バリデーションエラー(400)はエラーオブジェクトの配列を返します:
[
{
"memberNames": ["launch_url"],
"errorMessage": "The launch_url field is required."
},
{
"memberNames": ["exam_settings"],
"errorMessage": "exam_settings is required."
}
] 401エラーコード
| コード | 説明 |
|---|---|
2154 | アカウントが有効ではありません — アカウントマネージャーにお問い合わせください |
2155 | リージョンが正しくありません — 正しいリージョンのエンドポイントを使用してください |
2655 | 無効なAPIキー — キーの値を確認してください |
ベストプラクティス
- 送信前に必ずリクエストペイロードを検証してください
- 5xxエラーに対して指数バックオフによるリトライロジックを実装してください
- デバッグのためにエラーレスポンスの本文全体をログに記録してください
- クライアントサイドのコードにAPIキーを公開しないでください