スタートガイド

エラー

問題が発生すると、APIは該当するHTTPステータスと、error内にcodeとmessageを含むボディを返します。

プログラムではcodeを使用してください。messageはデバッグを助けるための英語のテキストで、変更される可能性があります。

エラーの形式404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}

キーなし401

{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

エラーコード

ステータス	コード	発生する状況
400	`key_in_query`	キーがURLで送信されました（パラメーター`api_key`、`apikey`、`key`、`token`）。キーはヘッダーで送信し、新しいキーを生成してください。以前のキーがログに記録されている可能性があります。
400	`invalid_parameter`	パラメーターの値が無効です（例：`per_page`が上限を超えている）。
401	`missing_api_key`	リクエストにキーが含まれていません。
401	`invalid_api_key`	キーが存在しないか、無効化されているか、キーのユーザーが無効になっています。
404	`not_found`	エンドポイントが存在しないか、項目が存在しないか、ユーザーが参照できない組織の項目です。
404	`organization_not_found`	指定された`organization`は、ユーザーがこの種類の項目を参照できる組織ではありません。
405	`method_not_allowed`	APIは`GET`（および`HEAD`）のみを受け付けます。
429	`rate_limited`	レート制限に達しました。`Retry-After`の秒数だけ待ってください。
500	`server_error`	内部エラーです。しばらくしてから再試行してください。解決しない場合は、サポートにお問い合わせください。

同じリクエストを再試行してよいのは、429（Retry-Afterだけ待ったうえで）または500の後だけです。その他のエラーでは、リクエストまたはキーの修正が必要です。