FreeiD APIガイド
  1. FAQ
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. FAQ

FAQ

よくある質問(FAQ)#

Q1. Client IDとClient Secretはどこで取得できますか?#

A. Client IDとClient Secretは、FreeiDサポートから発行されます。各クライアントアプリケーションごとに固有の値が発行されます。開発環境用と本番環境用で別々に発行される場合があります。

Q2. APIエンドポイントのURLはどこで確認できますか?#

A. APIエンドポイントのURLは、各クライアントアプリケーションの環境設定ファイルで管理されています。開発環境、ステージング環境、本番環境で異なるURLが使用されます。

Q3. FreeiDトークンの有効期限はどれくらいですか?#

A. FreeiDトークンの有効期限は、API仕様に準拠します。トークンが期限切れの場合、401エラーが返されるため、再度/provide/freeid/token APIを呼び出して新しいトークンを取得してください。

Q4. エラーが発生した場合、どのように対処すればよいですか?#

A. エラーレスポンスのcodeフィールドを確認し、エラーハンドリングセクションの対処法を参照してください。バリデーションエラーの場合、errorsフィールドに詳細なエラー情報が含まれます。認証エラー(401)の場合は、FreeiDトークンを再取得してください。

Q5. 顔認証を実行するにはどうすればよいですか?#

A. 以下の手順で実装します:
1.
Client ID/Client Secretでクライアント認証
2.
FreeiDトークンを取得
3.
顔認証APIにFreeiDトークンと顔画像データを送信
実装例は、実装例セクションを参照してください。

Q6. FreeiDトークンをキャッシュしてもよいですか?#

A. はい、FreeiDトークンは有効期限内であれば再利用できます。ただし、トークンが期限切れになった場合は、再取得が必要です。クライアント側でキャッシュして使用することを推奨します。

Q7. レート制限はありますか?#

A. 現在、レート制限は設けていませんが、過度なリクエストは避けてください。将来、レート制限が導入される可能性があります。

Q8. 複数のクライアントアプリケーションから同じFreeiDトークンを使用できますか?#

A. いいえ、各クライアントアプリケーションは、それぞれ独自にFreeiDトークンを取得して使用する必要があります。FreeiDトークンは、取得したクライアントアプリケーションでのみ有効です。
更新日時 2025-11-28 00:49:40
前へ
実装例
次へ
Pet
Built with