FreeiD APIガイド
  1. エラーハンドリング
FreeiD APIガイド
  • リリースノート
  • イントロダクション
    • イントロダクション
    • 主な機能とユースケース
    • 概要
    • API仕様
    • クイックスタート
    • 開始ガイド
    • 機能・技術特徴
    • 利用開始手順
      • 概要
      • 利用者情報暗号化のための鍵を生成する
      • FreeiD APIへアクセスするためのクレデンシャル情報を取得する
  • APIリファレンス
    • 認証・認可系 API
      • FreeiDトークン発行API(クライアント認証)
    • FreeiDユーザー API
      • FreeiDユーザー自身の情報取得
      • FreeiDユーザー情報取得(指定ID)
      • FreeiDユーザー顔画像の取得
      • FreeiDユーザーIDのカウントアップ
      • メールアドレスとパスワードによる本人確認
    • 顔識別API
      • 顔検出API
      • 本人確認
      • 顔画像でユーザー情報を取得
  • 認証方式
    • 認証方式
  • エラーハンドリング
    • エラーハンドリング
  • 実装例
    • 実装例
  • FAQ
    • FAQ
  • スキーマ
    • サンプルSchema
      • Pet
      • Category
      • Tag
    • Schemas
      • GenerateFreeidTokenRequest
      • GenerateFreeidTokenResponse
      • DecryptFreeIDTokenRequest
      • DecryptFreeIDTokenResponse
      • RefreshFreeidTokenResponse
      • FreeidUserInfo
      • AuthEmailInfo
      • FreeidAuthEmailResponseModel
  1. エラーハンドリング

エラーハンドリング

エラーハンドリング#

エラーレスポンス形式#

すべてのエラーレスポンスは、以下の統一された形式で返されます:
{
  "code": "errorCode",
  "message": "エラーメッセージ",
  "errors": {
    "field_name": "エラー詳細メッセージ"
  }
}

エラーコード一覧#

ステータスコードエラーコード説明
400badRequestリクエストの形式が正しくありません
401UnauthorizedID/パスワードが無効です
403keyInvalidAPIキーが無効です
403credentialInvalidユーザー認証に失敗しました
422validationError無効なパラメーターが含まれていました
500internalError内部エラーのため、リクエストは失敗しました

エラーハンドリングの実装例#

認証エラー#

認証エラーが発生した場合:
401 Unauthorized:Client ID/Client Secretが無効、またはFreeiDトークンが無効/期限切れ
403 Forbidden:認証は成功したが、リクエストしたAPIへのアクセス権限がない
トークンが期限切れの場合は、再度FreeiDトークンを取得してリトライしてください。
詳細は、認証方式セクションを参照してください。
更新日時 2025-11-28 00:48:15
前へ
認証方式
次へ
実装例
Built with