احراز هویت
دسترسی به 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)
پارامترها
| پارامتر | نوع | الزامی | پیشفرض | توضیح |
|---|---|---|---|---|
| priceId | int | بله | — | شناسه کالا (از خروجی prices.php) |
| amount | number | بله | — | مقدار درخواستی (وزن یا تعداد، بسته به نوع کالا) |
| fi | int | بله | — | قیمت پیشنهادی کاربر برای هر واحد |
| pd | int | بله | — | جهت درخواست: 1 = خرید، غیر از آن = فروش |
| totalPrice | int | خیر | — | فقط زمانی ارسال شود که مبلغ توسط مشتری وارد شده و رندسازی توسط شما انجام شده |
- کالا با priceId دادهشده باید وجود داشته باشد.
- مبلغ نهایی (amount × fi با احتساب rate) باید بیشتر از 10000 باشد، در غیر این صورت خطای Amount|Fi invalid.
- قیمت پیشنهادی (fi) باید در بازه ±0.5٪ نسبت به قیمت لحظهای خرید/فروش کاربر باشد، در غیر این صورت خطای fi invalid.
نمونه پاسخ
{
"success": true,
"message": "...",
"data": { "id": 123 }
}استعلام وضعیت یک درخواست. فقط درخواستهای متعلق به همان کاربر احراز هویتشده نتیجه میدهد. اگر پیدا نشود، data آبجکت خالی {} است.
محدودیت نرخ (هر IP): ۴ ثانیه
پارامترها
| پارامتر | نوع | الزامی | پیشفرض | توضیح |
|---|---|---|---|---|
| id | int | بله | — | شناسه درخواست (همان id بازگشتی از request.php) |
نمونه پاسخ
{
"success": true,
"message": "...",
"data": { "status": 3 }
}لیست درخواستهای ثبتشده کاربر، با صفحهبندی.
محدودیت نرخ (هر IP): ۵ ثانیه
پارامترها
| پارامتر | نوع | الزامی | پیشفرض | توضیح |
|---|---|---|---|---|
| dateFrom | YYYY-MM-DD | خیر | — | فیلتر از این تاریخ به بعد |
| dateTo | YYYY-MM-DD | خیر | — | فیلتر تا این تاریخ |
| page | int | خیر | 1 | شماره صفحه |
| limit | int | خیر | 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)
سایر مقادیر در مستند اصلی بهطور کامل مشخص نشدهاند.
