API仕様
レスポンスステータス
| HTTPコード | メッセージ | 説明 |
|---|---|---|
| 200 | OK | リクエストは正常に成功しました |
| 204 | No Content | 処理は成功しましたが、レスポンス本文は返されません |
| 400 | Bad Request | リクエストの構文が正しくありません |
| 401 | Unauthorized | 認証情報が不足または無効です |
| 404 | Not Found | 指定されたリソースが存在しません |
| 413 | Request Entity Too Large | 画像ファイルは5MB以下にしてください |
| 414 | Request-URI Too Long | リクエストURIが長すぎます（上限8KB） |
| 415 | Unsupported Media Type | サポートされていないContent-Typeです |
| 429 | Too Many Requests | リクエスト回数の上限を超えました |
| 500 | Internal Server Error | サーバー内部エラーが発生しました |
| 502 | Bad Gateway | 外部サービスから無効な応答を受信しました |
| 504 | Gateway Timeout | 外部サービスの応答がタイムアウトしました |
エラーメッセージ一覧
| エラーコード | 説明 | Type | 発生ケース |
|---|---|---|---|
| FRA0001 | クライアント認可に失敗しました | UnauthorizedException | API認可処理で認可トークンが無い、又は誤っている場合 |
| FRA0002 | ユーザー認可に失敗しました | UnauthorizedException | ユーザー認可処理で認可トークンが無い、又は誤っている場合 |
| FRA0003 | ユーザーが見つかりません | NotFoundException | FreeiDユーザー検索処理で該当ユーザーが見つからない場合 |
| FRA0004 | 顔画像の取得に失敗しました | ParameterValidationException | FreeiDユーザー顔画像取得処理でエラーが発生した場合 |
| FRA0005 | 顔画像が一致するユーザーが見つかりませんでした | NotFoundException | FreeiDユーザー顔画像認証で該当する顔情報が見つからなかった |
| FRA0006 | 顔画像が一致するユーザーが複数見つかりました | ConflictException | FreeiDユーザー顔画像認証で該当する顔情報が複数見つかった |
エラーレスポンス構造（例）
{
"error_type": "AuthorizerDeniedApiException",
"error_messages": [
{
"code": "FECOM0034",
"mapping": {}
}
]
}| 項目 | 説明 |
|---|---|
| error_type | エラーの種別を返します |
| error_messages | エラーメッセージの詳細をリストで返します |
| code | エラーコード（仕様書の一覧を参照） |
| mapping | バリデーションエラー発生時に、該当フィールド（例：email）を返します |
更新日時 2025-04-23 02:12:31