認証方式

FreeiD APIでは、クライアント認証とFreeiDトークン認証の2段階認証方式を採用しています。

1. クライアント認証（Client ID/Client Secret）

すべてのクライアントアプリケーションは、まずClient IDとClient Secretを使用して認証を行う必要があります。

Client ID/Client Secretの取得

Client IDとClient Secretは、FreeiDサポートから発行されます。クライアントアプリケーションごとに固有の値が発行されます。

重要：Client Secretは機密情報です。クライアント側のコードに直接埋め込まず、環境変数や設定ファイル、または安全なストレージから読み込むようにしてください。

Basic認証による認証

Client IDとClient Secretを使用して、Basic認証でAPIに認証します：

実装例：

2. FreeiDトークンの取得

クライアント認証に成功すると、FreeiDトークンが発行されます。このトークンを使用して、各種APIを呼び出すことができます。

FreeiDトークン提供API

認証済みのクライアントは、FreeiDトークンを取得するAPIを呼び出します：

エンドポイント：GET /v1/provide/freeid/token

リクエストヘッダー：

レスポンス：

ヘッダー：X-FreeiD-Tokens にFreeiDトークンが含まれる

または、レスポンスボディにFreeiDトークンが含まれる

3. FreeiDトークンによるAPI認証

取得したFreeiDトークンを使用して、各種APIを呼び出します：

または

認証フローの全体像

┌─────────────────────────────────────────────────────────┐
│  1. クライアント認証                                     │
│     Client ID + Client Secret → Basic認証               │
└────────────────────┬────────────────────────────────────┘
                     │
                     ▼
┌─────────────────────────────────────────────────────────┐
│  2. FreeiDトークン取得                                   │
│     /v1/provide/freeid/token → FreeiD Token            │
└────────────────────┬────────────────────────────────────┘
                     │
                     ▼
┌─────────────────────────────────────────────────────────┐
│  3. API呼び出し                                         │
│     FreeiD Token → 各種API（顔認証、ユーザー管理など）  │
└─────────────────────────────────────────────────────────┘

実装例：完全な認証フロー

JavaScript/TypeScriptの例

Pythonの例

トークンの種類と用途

トークン	用途	有効期限	取得方法
サービスFreeiD Token	FreeiDプラットフォームの認証トークン。FreeiDプラットフォームサービス機能を利用時に使用	API仕様に準拠	FreeiD Webでログイン時に発行。サービス一覧から画面遷移時に取得。
FreeiD Token	API呼び出し用の認証トークン。すべてのAPIで使用	API仕様に準拠	クライアント認証後に`/provide/freeid/token`から取得

エラーハンドリング

認証エラーが発生した場合：

401 Unauthorized：Client ID/Client Secretが無効、またはFreeiDトークンが無効/期限切れ

403 Forbidden：認証は成功したが、リクエストしたAPIへのアクセス権限がない

トークンが期限切れの場合は、再度FreeiDトークンを取得してリトライしてください。

詳細は、エラーハンドリングセクションを参照してください。

認証方式

認証方式#

1. クライアント認証（Client ID/Client Secret）#

Client ID/Client Secretの取得#

Basic認証による認証#

2. FreeiDトークンの取得#

FreeiDトークン提供API#

3. FreeiDトークンによるAPI認証#

認証フローの全体像#

実装例：完全な認証フロー#

JavaScript/TypeScriptの例#

Pythonの例#

トークンの種類と用途#

エラーハンドリング#

認証方式

1. クライアント認証（Client ID/Client Secret）

Client ID/Client Secretの取得

Basic認証による認証

2. FreeiDトークンの取得

FreeiDトークン提供API

3. FreeiDトークンによるAPI認証

認証フローの全体像

実装例：完全な認証フロー

JavaScript/TypeScriptの例

Pythonの例

トークンの種類と用途

エラーハンドリング