ドキュメント / 入門 /

入門

FreshCreditプラットフォームとの統合のためのクイックスタートガイド。環境を設定し、最初のAPI呼び出しを行い、中核的な概念を理解します。

認証APIキー、OAuth 2.0、セキュリティ BlockID™ID認証API ブロックスコア™クレジットスコアリングモデルAPI BlockIQ™オファーマッチングとマーケットプレイス SDK公式クライアントライブラリ

統合ステップ /

ステップ 01

アカウントを作成

app.freshcredit.comでFreshCreditプロバイダーアカウントにサインアップします。オンボーディングフローを完了して、組織IDと初期APIクレデンシャルを取得します。

ステップ 02

APIキーを取得

ダッシュボードで設定 > APIキーに移動します。本番環境のAPIキーを生成し、安全に保存します。FreshCreditは認証にHMAC-SHA256署名リクエストを使用します。

// Your API credentials
const API_KEY = 'fc_live_xxxxxxxxxxxxxxxx'
const API_SECRET = 'fc_secret_xxxxxxxxxxxxxxxx'

ステップ 03

最初のリクエストを実行

シンプルなヘルスチェックで統合をテストします。すべてのAPIリクエストには、AuthorizationヘッダーにAPIキーとタイムスタンプ署名が含まれている必要があります。

curl -X GET https://api.freshcredit.com/v1/health \
  -H "Authorization: Bearer fc_live_xxxxxxxxxxxxxxxx" \
  -H "X-FreshCredit-Signature: {hmac_signature}" \
  -H "Content-Type: application/json"

ステップ 04

BlockID™を統合

ID認証から始めます。BlockID™は、ゼロ知識証明によるプライバシー保護認証でKYC/AML自動化を提供します。

const response = await fetch('https://api.freshcredit.com/v1/blockid/verify', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'X-FreshCredit-Signature': signature,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    user_id: 'user_123',
    verification_type: 'kyc_basic',
  }),
});

中核的概念 /

自己管理データ

ユーザーはエッジホールドウォレットを通じて自分のIDとクレジットデータを所有・管理します。中央集権型のデータ管理がないため、単一障害点が排除されます。

イベント駆動アーキテクチャ

FreshCreditはリアルタイム通知にウェブフックを使用します。ダッシュボードでウェブフックエンドポイントを設定し、認証、スコア更新、決済のイベントを受信します。

階層型アクセス

MSAライセンス付きAPIアクセスは3つの階層があります：Partner（フルプラットフォーム）、Provider（特定の製品）、User（自己管理データ）。各階層には特定のレート制限と機能があります。

RESTful API設計

すべてのAPIはREST規約に従い、JSONペイロードを使用します。ベースURLはhttps://api.freshcredit.com/v1/で、パスにバージョニングが含まれます。

次のステップ

認証を設定 BlockID™を探索

const response = await fetch('https://api.freshcredit.com/v1/blockid/verify', { method: 'POST', headers: { 'Authorization': `Bearer ${API_KEY}`, 'X-FreshCredit-Signature': signature, 'Content-Type': 'application/json', }, body: JSON.stringify({ user_id: 'user_123', verification_type: 'kyc_basic', }), });