エラーコード
MenuGaze の API エンドポイントは標準の HTTP ステータスコードを返します。エラーレスポンスには、問題の詳細を含む JSON ボディが含まれます。
エラーレスポンスの形式
{
"success": false,
"error": "Human-readable error message"
}
ステータスコード
| コード | 意味 | 主な原因 |
|---|---|---|
200 |
OK | リクエストが成功しました。レスポンスボディに要求したデータが含まれます。 |
201 |
Created | リソースが正常に作成されました。成功時に POST エンドポイントから返されます。 |
400 |
Bad Request | リクエストボディのフィールドが不足しているか、無効です。すべての必須フィールドが存在し、正しい形式であることを確認してください。 |
401 |
Unauthorized | 認証トークンがないか、無効です。Authorization ヘッダーに有効な Bearer トークンを含めていることを確認してください。トークンの有効期限が切れている可能性があります — 再度ログインして新しいトークンを取得してください。 |
403 |
Forbidden | 認証済みですが、このリソースにアクセスする権限がありません。通常は、別のレストランに属するリソースにアクセスまたは変更しようとしていることを意味します。 |
404 |
Not Found | 要求したリソースが存在しません。URL パス内の ID が正しいことを確認してください。 |
429 |
Too Many Requests | レート制限を超えました。再試行までに待つべき秒数は Retry-After ヘッダーで確認してください。認証エンドポイントは IP あたり 15 分間に 10 リクエストに制限されています。注文の作成は IP あたり毎分 5 リクエストに制限されています。 |
500 |
Internal Server Error | サーバーで予期しないエラーが発生しました。問題が続く場合は、サポートにお問い合わせください。これらのエラーは調査のために自動的に記録されます。 |
503 |
Service Unavailable | サービスが一時的に利用できません。メンテナンス中や、必要な外部サービス (例: ワーカーシークレット) が設定されていない場合に発生することがあります。少し時間をおいてから再試行してください。 |
レート制限
レート制限のあるエンドポイントは、制限を超えると 429 ステータスを返します。レスポンスには次のものが含まれます。
-
Retry-Afterヘッダー — 次のリクエストを送信するまでに待つべき秒数。 - 超過したレート制限を示すエラーメッセージ。
レート制限は IP アドレスごとに適用されます。現在の制限は次のとおりです。
| エンドポイント | 制限 |
|---|---|
| ログインとサインアップ | IP あたり 15 分間に 10 リクエスト |
| 注文の作成 | IP あたり毎分 5 リクエスト |
| 関連アイテム | IP あたり毎分 30 リクエスト |