احراز هویت و اندپوینت حساب

هر درخواست یک هدر حمل می‌کند. GET /account همان اندپوینتی است که صدا می‌زنید تا ثابت کنید کلید کار می‌کند، موجودی کیف پولی را که سفارش‌ها از آن کسر می‌شوند بخوانید و پیش از شروع یک اجرای دسته‌ای مطمئن شوید حساب فعال است.

یک درخواست چگونه احراز هویت می‌شود

هدر Authorization یک اعتبار Bearer را حمل می‌کند که از شناسه کلید و secret تشکیل شده و با یک نقطه به هم پیوسته‌اند. شناسه کلید حساب را انتخاب می‌کند و secret با یک مقایسه HMAC بررسی می‌شود؛ بررسی ناموفق پیش از اجرای خود مسیر، با MISSING_API_KEY یا INVALID_API_KEY پاسخ 401 می‌دهد. هیچ چیز دیگری بررسی نمی‌شود — نه کوکی، نه توکن CSRF و نه هدر origin.

فهرست IP مجاز

یک کلید را می‌توان به مجموعه‌ای از آدرس‌های مبدأ محدود کرد. تا وقتی این فهرست خالی نباشد، درخواست از هر آدرس دیگری — پیش از محدودیت نرخ و پیش از هر مراجعه به کیف پول — با IP_NOT_ALLOWED و HTTP 403 رد می‌شود، بنابراین یک اعتبار دزدیده‌شده بیرون از زیرساخت خودتان قابل استفاده نیست. فهرست خالی یعنی کلید از هر جایی کار می‌کند.

وضعیت حساب

دو شرط در سطح حساب هر اندپوینتی را قطع می‌کنند: حساب غیرفعال با ACCOUNT_DISABLED و حساب مسدود با ACCOUNT_FROZEN پاسخ می‌دهد، هر دو با HTTP 403. هیچ‌کدام خودبه‌خود برطرف نمی‌شوند، بنابراین به‌جای تکرار در یک حلقه، آن‌ها را به یک انسان ارجاع دهید.

تعویض کلید

کلیدها در صفحه API Access پنل نمایندگی ساخته و حذف می‌شوند. چون secret تنها یک بار هنگام ساخت نمایش داده می‌شود، تعویض یعنی بساز، منتشر کن، حذف کن؛ نه ویرایش در جا. اعتبارها خودبه‌خود منقضی نمی‌شوند، یعنی زمان‌بندی تعویض با شماست.

GET

/account

Get Account Info

Retrieve detailed account information including wallet balance, account status, and creation date.

محدودیت نرخ60 req / 60s per user

درخواست

curl -s "https://shop2topup.com/api/endpoints/v1/account" \
  -H "Authorization: Bearer YOUR_KEY_ID.YOUR_KEY_SECRET"

نمونه پاسخ

{
  "success": true,
  "account": {
    "id": 42,
    "email": "[email protected]",
    "username": "partner_store",
    "client_type": "reseller",
    "wallet": "1250.500000",
    "enabled": true,
    "verified": true,
    "created_at": "2024-01-15T10:30:00Z"
  }
}

یک درخواست واقعی را از همین صفحه بفرستید

برای فراخوانی زنده این اندپوینت‌ها یک کلید API را بچسبانید. کلید در همین تب مرورگر می‌ماند و تنها به خود API فرستاده می‌شود.

Enter your API key to use the interactive playground. Get your API key

یک اندپوینت انتخاب کنید

Enter your API key above to try this endpoint.

Response will appear here after sending a request.

تازه با پلتفرم آشنا شده‌اید؟ از معرفی API شارژ بازی برای نمایندگان فروش شروع کنید، یا معرفی برنامه نمایندگی SHOP2TOPUP را بخوانید تا ببینید حساب شریک چگونه کار می‌کند.