API Reference
محصولات
کاتالوگ، دستهبندیها و جزئیات قیمت و فیلدهای الزامی هر محصول را دریافت کنید. برای ثبت سفارش همیشه از داده تازه جزئیات محصول استفاده کنید.
GET
/api/v1/productsدریافت فهرست محصولات
محصولات را با اطلاعات پایه و صفحهبندی برمیگرداند. قیمت و پراپرتیهای قابل سفارش در این پاسخ نیستند.
پارامترها
4 مورد| نام | نوع | الزام | توضیحات |
|---|---|---|---|
page | number | اختیاری | شماره صفحه؛ مقدار پیشفرض ۱ است. |
pageSize | number | اختیاری | تعداد آیتم در هر صفحه؛ مقدار پیشفرض ۱۰ است. |
category | string | اختیاری | یکی از مقادیر GIFTCARD، PREMIUM، GAME یا APP. |
search | string | اختیاری | جستوجو در نام، عنوان کارت و توضیحات محصول. |
page- numberاختیاری
- شماره صفحه؛ مقدار پیشفرض ۱ است.
pageSize- numberاختیاری
- تعداد آیتم در هر صفحه؛ مقدار پیشفرض ۱۰ است.
category- stringاختیاری
- یکی از مقادیر GIFTCARD، PREMIUM، GAME یا APP.
search- stringاختیاری
- جستوجو در نام، عنوان کارت و توضیحات محصول.
نمونه داده
Responsejson
{
"status": "success",
"code": 200,
"data": [
{
"id": 123,
"name": "گیفت کارت استیم",
"description": "خرید گیفت کارت استیم با تحویل آنی",
"category": "GIFTCARD",
"slug": "steam-giftcard",
"image": "https://gift30t.ir/products/steam.png",
"regions": [
{
"id": 1,
"name": "Global",
"flag": "global"
}
]
}
],
"meta": {
"pagination": {
"total": 24,
"page": 1,
"pageSize": 10,
"totalPages": 3
}
}
}GET
/api/v1/products/category/:idمحصولات یک دستهبندی
محصولات متعلق به یک دستهبندی معتبر را با همان ساختار فهرست محصولات برمیگرداند.
پارامترها
3 مورد| نام | نوع | الزام | توضیحات |
|---|---|---|---|
id | string | الزامی | شناسه دستهبندی: GIFTCARD، PREMIUM، GAME یا APP. |
page | number | اختیاری | شماره صفحه؛ مقدار پیشفرض ۱ است. |
pageSize | number | اختیاری | تعداد آیتم در هر صفحه؛ مقدار پیشفرض ۱۰ است. |
id- stringالزامی
- شناسه دستهبندی: GIFTCARD، PREMIUM، GAME یا APP.
page- numberاختیاری
- شماره صفحه؛ مقدار پیشفرض ۱ است.
pageSize- numberاختیاری
- تعداد آیتم در هر صفحه؛ مقدار پیشفرض ۱۰ است.
نمونه داده
Responsejson
{
"status": "success",
"code": 200,
"data": [
{
"id": 123,
"name": "گیفت کارت استیم",
"description": "خرید گیفت کارت استیم با تحویل آنی",
"category": "GIFTCARD",
"slug": "steam-giftcard",
"image": "https://gift30t.ir/products/steam.png",
"regions": [
{
"id": 1,
"name": "Global",
"flag": "global"
}
]
}
],
"meta": {
"pagination": {
"total": 15,
"page": 1,
"pageSize": 10,
"totalPages": 2
},
"category": "GIFTCARD"
}
}GET
/api/v1/products/:idدریافت جزئیات محصول
قیمتها، موجودی، regionPropertyId، فیلدهای الزامی، FAQ و راهنمای فعالسازی یک محصول را برمیگرداند.
پارامترها
1 مورد| نام | نوع | الزام | توضیحات |
|---|---|---|---|
id | number | الزامی | شناسه عددی محصول. |
id- numberالزامی
- شناسه عددی محصول.
نمونه داده
Responsejson
{
"status": "success",
"code": 200,
"data": {
"id": 123,
"name": "گیفت کارت استیم",
"description": "خرید گیفت کارت استیم با تحویل آنی",
"category": "GIFTCARD",
"slug": "steam-giftcard",
"image": "https://gift30t.ir/products/steam.png",
"content": "توضیحات کامل محصول",
"regions": [
{
"id": 1,
"name": "Global",
"flag": "global",
"properties": [
{
"id": 101,
"title": "10 دلاری",
"price": 490000,
"originalPrice": 510000,
"stock_status": "INSTOCK"
}
]
}
],
"requiredFields": [
{
"id": 1,
"fieldName": "ایمیل",
"fieldType": "EMAIL"
}
],
"faq": [
{
"title": "چگونه محصول را فعال کنم؟",
"description": "راهنمای کوتاه فعالسازی"
}
],
"redeemGuide": "راهنمای کامل فعالسازی محصول"
}
}GET
/api/v1/products/categoriesدریافت دستهبندیها
تمام دستهبندیهای قابل استفاده در API را همراه تعداد محصولات هر دسته برمیگرداند.
نمونه داده
Responsejson
{
"status": "success",
"code": 200,
"data": [
{ "id": "GIFTCARD", "name": "گیفت کارت", "count": 15 },
{ "id": "PREMIUM", "name": "اشتراک پریمیوم", "count": 8 },
{ "id": "GAME", "name": "بازی", "count": 12 },
{ "id": "APP", "name": "اپلیکیشن", "count": 5 }
]
}