Docsエラーコード
エラーコード (Errors)
FindIP API は標準 HTTP ステータスコードを使用し、原因の詳細を含む JSON エラーレスポンスを返します。
エラーレスポンスの形式
すべてのエラーレスポンスは次の構造に従います。
JSON
{
"detail": "人が読めるエラーメッセージ"
}HTTP ステータスコード
成功
| コード | ステータス | 説明 |
|---|---|---|
200 | OK | リクエスト成功。 |
300 | Multiple Choices | 文書 ID が複数の特許に一致しました。(文書詳細 API を参照) |
クライアントエラー
| コード | ステータス | 説明 |
|---|---|---|
400 | Bad Request | 不正なリクエスト形式。必須フィールド (例: query) の欠落、もしくはパラメータ型/値の誤り。 |
401 | Unauthorized | 無効または欠落した API キー。Authorization ヘッダをご確認ください。 |
403 | Forbidden | API キーは有効ですが、当該操作の権限がありません。 |
404 | Not Found | リクエストされたリソースが見つかりません。(例: 存在しない文書 ID) |
429 | Too Many Requests | 月間検索枠を超過、もしくは 1 分あたり 60 回のレート制限に到達しました。プランのアップグレードもしくは次回請求日までお待ちください。 |
サーバーエラー
| コード | ステータス | 説明 |
|---|---|---|
500 | Internal Server Error | 予期せぬサーバー側エラーが発生しました。少し時間をおいてから再試行してください。 |
503 | Service Unavailable | サーバーが一時的に利用できません。(メンテナンスまたは高負荷) |
よくあるエラーケース
API キーの欠落・誤り
401 Unauthorized
{
"detail": "Invalid API key"
}リクエストに Authorization: Bearer psk_live_xxx ヘッダが含まれているかご確認ください。
月間検索枠の超過
429 Too Many Requests
{
"detail": "Monthly limit exceeded"
}月間検索枠に達しました。枠は請求日基準で毎月自動リセットされます。詳細・図面・番号照会はカウント対象外です。使用量ダッシュボードで状況をご確認ください。
必須フィールドの欠落
400 Bad Request
{
"detail": "Field 'query' is required"
}文書が見つからない
404 Not Found
{
"detail": "Document not found"
}publication_id の形式をご確認ください。国コードを含む完全な ID をご利用ください。(例: 12261291 ではなく US12261291B2)
エラー処理のベストプラクティス
- レスポンスボディをパースする前に必ず HTTP ステータスコードを確認してください。
429・500時は指数バックオフ (Exponential Backoff) でリトライしてください。- デバッグのため、エラーレスポンス全体をログに残してください。
detailフィールドに原因特定の主要情報が入ります。 300 Multiple Choicesが返ったら、候補一覧をユーザーに提示して選択させてください。- 適切なリクエストタイムアウトを設定してください (検索は 30 秒、その他は 10 秒推奨)。