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

イントロダクション

FreeiD APIリファレンス#

目的:本ドキュメントは、FreeiD APIを使用するすべてのクライアントアプリケーション向けのAPIリファレンスです。FreeiD APIを導入・検証・連携する技術担当者向けに、全体像・用語定義・利用手順・エラーハンドリングおよび各APIの詳細仕様を示すものです。
想定読者:FreeiD APIと連携実装を行うフロントエンド/バックエンドエンジニア

イントロダクション#

FreeiD APIリファレンスへようこそ。
このセクションでは、FreeiD APIの概要、機能、開始方法について説明します。

目次#

概要 - FreeiD APIについて、クライアントアプリケーションの実装パターン
機能・技術的特徴 - FreeiD APIで実現できること、技術的特徴
開始ガイド - 実装を開始するための手順
APIカテゴリ - 主要なAPIカテゴリとドキュメント構成

次のステップ#

実装を開始する前に、以下を確認してください:
1.
概要 - FreeiD APIの基本的な理解
2.
開始ガイド - Client ID/Client Secretの取得と開発環境の準備
3.
認証方式 - 認証の仕組みを理解する
4.
エラーハンドリング - エラー形式を確認する
更新日時 2025-11-28 00:44:45
前へ
リリースノート
次へ
主な機能とユースケース
Built with