FreeiD APIガイド
イントロダクション
ページをコピー
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
イントロダクション
ページをコピー
概要
概要
#
FreeiD APIについて
#
本ドキュメントは、
FreeiD API
を使用するすべてのクライアントアプリケーション向けのリファレンスです。FreeiD APIは、Webアプリケーション、モバイルアプリケーション、その他のサービスから呼び出すことができます。
FreeiDは、
一つのIDでさまざまなサービスを利用可能にする統合IDプラットフォーム
です。本APIを利用することで、個人認証、認可機能、ユーザー管理、顔認証などを安全かつ効率的に実装できます。
使用例
:
Webアプリケーション(Angular、React、Vue.jsなど)
モバイルアプリケーション(iOS、Android)
バックエンドサービス(各種サーバーサイドアプリケーション)
クライアントアプリケーションの実装パターン
#
FreeiD APIを使用するクライアントアプリケーションは、以下のパターンで実装されます:
1.
クライアント認証
:Client IDとClient Secretを使用して認証
2.
FreeiDトークン取得
:認証後にFreeiDトークンを取得
3.
API呼び出し
:FreeiDトークンを使用して各種APIを呼び出す
詳細は、
認証方式
セクションを参照してください。
概念 / 用語
#
用語
説明
会員情報
FreeiDのサービスに登録された氏名、メールアドレス、電話番号などの基本情報
サービス
FreeiDと連携する各種サービス。FreeiD会員が個別に利用可否を選択できる
オプトイン
会員が特定サービスとの連携を開始すること
オプトアウト
特定サービスとの連携を解除すること
FreeiDトークン
認証・認可に使用される暗号化トークン。認証情報とアクセス権限を含む
更新日時
2025-11-28 00:50:19
前へ
主な機能とユースケース
次へ
API仕様