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. イントロダクション

クイックスタート

APIリファレンスページ上でAPIを試す方法は以下の通りです。
1.
APIリファレンスページで、メニューから使用するAPIを選択
2.
Header にFreeiDトークンを貼り付け
3.
必要なパラメータを入力
4.
「Try it!」ボタンをクリック

FreeiD API#

FreeiDトークン発行API(クライアント認証)#

概要#

クライアントIDとシークレットを使用してクライアント認証を行い、FreeiDトークンを発行します。
エンドポイント:POST https://api.resource.freeid.jp/v1/my-page-auth/v1/auth/client/{service_id}
認証:Basic
レスポンス形式:JSON

パラメータ(Body)#

なし

サンプルリクエスト#

備考#

CLIENT_ID, SECRET_ID, SERVICE_ID は弊社が事前に発行した情報をご指定ください。
Authorization ヘッダーには、クライアントID:シークレットID を base64 エンコードした値を指定してください。

フロントエンド実装サンプル#

現在準備中です。準備が整い次第、本セクションを更新いたします。

更新日時 2025-04-23 02:14:24
前へ
API仕様
次へ
開始ガイド
Built with