شروع
راهنمای شروع سریع برای یکپارچهسازی با پلتفرم FreshCredit. محیط خود را راهاندازی کنید، اولین تماس API خود را انجام دهید و مفاهیم اصلی را درک کنید.
ایجاد حساب کاربری
در app.freshcredit.com برای حساب ارائهدهنده FreshCredit ثبتنام کنید. جریان onboarding را تکمیل کنید تا شناسه سازمان و اعتبارنامه API اولیه خود را دریافت کنید.
دریافت کلیدهای API
به تنظیمات > کلیدهای API در داشبورد خود بروید. یک کلید API تولیدی ایجاد کنید و آن را به طور ایمن ذخیره کنید. FreshCredit از درخواستهای امضا شده HMAC-SHA256 برای احراز هویت استفاده میکند.
// Your API credentials
const API_KEY = 'fc_live_xxxxxxxxxxxxxxxx'
const API_SECRET = 'fc_secret_xxxxxxxxxxxxxxxx'اولین درخواست خود را انجام دهید
یکپارچهسازی خود را با یک بررسی سلامت ساده آزمایش کنید. تمام درخواستهای API باید شامل کلید API شما در هدر Authorization و یک امضای timestamp شده باشند.
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"یکپارچهسازی BlockID™
با تأیید هویت شروع کنید. 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',
}),
});دادههای خودحفاظتی
کاربران از طریق کیفپولهای edge-held مالک و کنترلکننده دادههای هویت و اعتبار خود هستند. عدم نگهداری متمرکز دادهها نقاط شکست واحد را حذف میکند.
معماری مبتنی بر رویداد
FreshCredit برای اعلانهای بلادرنگ از webhooks استفاده میکند. نقاط پایانی webhook را در داشبورد خود پیکربندی کنید تا رویدادهای تأیید، بهروزرسانیهای امتیاز و تسویهها را دریافت کنید.
دسترسی لایهای
دسترسی API با مجوز MSA دارای سه لایه است: Partner (پلتفرم کامل)، Provider (محصولات خاص) و User (دادههای خودحفاظتی). هر لایه دارای محدودیتهای نرخ و قابلیتهای خاص است.
API RESTful
همه APIها از قراردادهای REST با payloadهای JSON پیروی میکنند. URL پایه https://api.freshcredit.com/v1/ است با نسخهبندی در مسیر.