شروع سریع

در چند دقیقه آماده استفاده از API بشوید

01

ساخت حساب فروشنده

حساب فروشنده را در اپ یا پنل Credexa بسازید. ورود کاربران بخشی از Partner API عمومی نیست.

bash
# Partner API فقط با X-Api-Key فراخوانی می‌شود.
# عملیات ورود و OTP در اپ امن Credexa انجام می‌شود و endpoint عمومی ندارد.
02

دریافت کلید API

پس از ورود، از داشبورد مدیریت یک کلید API جدید بسازید. کلیدها توسط ادمین تأیید می‌شوند.

bash
# از داشبورد Credexa (credexa.ir) کلید API بسازید
# یا از مسیر وب:
curl -X POST https://credexa.ir/api/keys \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "production-key", "expires_in": 365}'

# Response
{
  "id": "key_01jxxxxxxxx",
  "key": "fc_live_xxxxxxxxxxxxxxxxxxxxxxxx",
  "expires_at": "2027-05-31T00:00:00Z"
}
03

اولین درخواست API

کلید API را در هدر X-Api-Key قرار دهید و اولین درخواست را ارسال کنید.

bash
curl -X GET https://api.credexa.ir/v1/products \
  -H "X-Api-Key: fc_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json"

# Response
{
  "data": [
    { "id": "prod_01", "name": "محصول نمونه", "price": 5000000 }
  ],
  "total": 1
}

محدودیت نرخ و صف

سقف کلی کلید معمولاً ۱۰۰ درخواست در دقیقه است، اما APIهای سنگین سقف جدا دارند (اعتبار ۲۰/دقیقه، هویت ۳۰/دقیقه، batch محصول ۱۰/دقیقه). برای ارسال انبوه حتماً صف بسازید و سیاست‌ها را با GET /v1/rate-limits بخوانید.

مشاهده بخش محدودیت نرخ در مستندات

آماده‌اید؟

برای مشاهده تمام endpoint‌ها و مستندات تعاملی کامل به پورتال API مراجعه کنید.

مشاهده مستندات API
ایمیل
تلگرام
پشتیبانی آنلاین