エラー処理

API は標準の HTTP ステータス コードによってエラーを通知します。つまり、レスポンスが成功すると 2XX ステータス コードが返され、エラーは 4XX または 5XX で報告されます。

TestRail API を使用するアプリケーションやライブラリは、５XX エラーに対処する必要があり、５XX  の場合は後でリクエストを再試行することが期待されています。 ４XX エラーはクライアント側のエラーであり、通常、リクエストが不正、または不完全であること、たとえば存在しないテスト ケースを読み取ろうとしている、または無効な要求形式を使用していることを示します。下記のステータス コードそれぞれについて、レスポンスのボディにはリクエストの成功または失敗に関する追加の情報が含まれます。

レスポンス コード

ステータス コード	説明
200	成功。
400	リクエストされたエンティティが存在しないか、POST リクエストのボディの書式が適切ではありません。
401	認証が失敗しました。認証情報が無効である可能性があります。
403	アクセスが拒否されました。パーミッションが適切ではない可能性があります。
404	API エンドポイントが存在しません。
500	サーバー エラー。

API レート制限

すべてのユーザーに最適なパフォーマンスを保証するため、TestRail Cloud では、API はレート制限されており、リクエストが絞られる場合があることに注意してください。また、TestRail は 429 Too Many Requests レスポンスを返す場合があり、ユーザーはこれに対処する必要があります。

TestRail Cloud でレート制限を避けるには、一括 API エンドポイントを使用したり (add_results_for case ではなく add_results_for_cases を使用するなど)、API 呼び出しの間に遅延時間を設けることを検討してください。