احراز هویت

دسترسی به API با دو روش کنترل می‌شود: لیست سفید IP و هدر x-api-key.

لینک api ها به صورت : https://example.ir/server/api/branchSystem/ENDPOINT.php می باشد

پارامترهای متد POST به صورت Form-Data می باشد

در صورت نامعتبر بودن هر کدام، پاسخ 403 برگردانده می‌شود.

اندپوینت‌ها

لیست تمام کالاها/ارزهای قابل معامله را به همراه قیمت خرید و فروش برمی‌گرداند.

محدودیت نرخ (هر IP): ۵ ثانیه

پارامترها

بدون پارامتر ورودی.

نمونه پاسخ

{
  "success": true,
  "message": "...",
  "data": { {
      "id": 1,
      "name": "نقد فردا",
      "type": 1,
      "rate": 4.3318,
      "price": 1067000000,
      "profit": 250000,
      "priceBuy": 1067250000,
      "priceSell": 1066750000,
      "allowSell": 1,
      "allowBuy": 1,
      "min": 1,
      "max": 1000,
      "dailyAmount": 10000,
      "isActive": 1,
      "lastUpdateTime": "2026-11-16 14:46:28"
    }, ... }
}

ثبت یک درخواست جدید خرید/فروش. پاسخ فقط شناسه (id) را برمی‌گرداند و کد وضعیت موفق 201 است.

محدودیت نرخ (هر IP): ۲ ثانیه

Content-Type: application/x-www-form-urlencoded (پارامترها از طریق $_POST)

پارامترها

پارامترنوعالزامیپیش‌فرضتوضیح
priceIdintبله—شناسه کالا (از خروجی prices.php)
amountnumberبله—مقدار درخواستی (وزن یا تعداد، بسته به نوع کالا)
fiintبله—قیمت پیشنهادی کاربر برای هر واحد
pdintبله—جهت درخواست: 1 = خرید، غیر از آن = فروش
totalPriceintخیر—فقط زمانی ارسال شود که مبلغ توسط مشتری وارد شده و رندسازی توسط شما انجام شده
  • کالا با priceId داده‌شده باید وجود داشته باشد.
  • مبلغ نهایی (amount × fi با احتساب rate) باید بیشتر از 10000 باشد، در غیر این صورت خطای Amount|Fi invalid.
  • قیمت پیشنهادی (fi) باید در بازه ±0.5٪ نسبت به قیمت لحظه‌ای خرید/فروش کاربر باشد، در غیر این صورت خطای fi invalid.

نمونه پاسخ

{
  "success": true,
  "message": "...",
  "data": { "id": 123 }
}

استعلام وضعیت یک درخواست. فقط درخواست‌های متعلق به همان کاربر احراز هویت‌شده نتیجه می‌دهد. اگر پیدا نشود، data آبجکت خالی {} است.

محدودیت نرخ (هر IP): ۴ ثانیه

پارامترها

پارامترنوعالزامیپیش‌فرضتوضیح
idintبله—شناسه درخواست (همان id بازگشتی از request.php)

نمونه پاسخ

{
  "success": true,
  "message": "...",
  "data": { "status": 3 }
}

لیست درخواست‌های ثبت‌شده کاربر، با صفحه‌بندی.

محدودیت نرخ (هر IP): ۵ ثانیه

پارامترها

پارامترنوعالزامیپیش‌فرضتوضیح
dateFromYYYY-MM-DDخیر—فیلتر از این تاریخ به بعد
dateToYYYY-MM-DDخیر—فیلتر تا این تاریخ
pageintخیر1شماره صفحه
limitintخیر20تعداد آیتم در هر صفحه (حداکثر 100)
  • اگر هیچ‌کدام از dateFrom و dateTo ارسال نشوند، فقط درخواست‌های امروز برگردانده می‌شوند.

نمونه پاسخ

{
  "success": true,
  "message": "",
  "data": {
    "items": [
      {
        "id": 346516,
        "priceName": "نقد فردا",
        "userName": "علیرضا",
        "state": 3,
        "weight": 25,
        "count": 0,
        "fi": "1067250000",
        "amount": "6159391015",
        "pd": 1,
        "ip": "::1",
        "answerTime": "2026-11-21 15:43:36",
        "createdAt": "2026-11-21 15:43:36"
      },
      {
        "id": 346515,
        "priceName": "نقد فردا",
        "userName": "علیرضا",
        "state": 3,
        "weight": 100,
        "count": 0,
        "fi": "1066750000",
        "amount": "24626021515",
        "pd": -1,
        "ip": "::1",
        "answerTime": "2026-11-21 15:43:30",
        "createdAt": "2026-11-21 15:43:30"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 2,
      "totalPages": 1
    }
  }
}

کدهای وضعیت HTTP

کدتوضیح
200موفق
201ایجاد شد
400درخواست نامعتبر
403دسترسی غیرمجاز (IP یا x-api-key نامعتبر)
405متد HTTP مجاز نیست
429محدودیت نرخ درخواست (Rate limit)

وضعیت درخواست (status)

-1در انتظار
0بی‌پاسخ
2رد شده
3تأیید شده

سایر مقادیر در مستند اصلی به‌طور کامل مشخص نشده‌اند.