معرفی API
این API لیست هدایا را از دیتابیس برمیگرداند. هر آیتم شامل شناسه، نام، ایموجی، قیمت و کارمزد است. پاسخ نهایی به صورت JSON برگردانده میشود.
tokenEndpoint
برای دریافت لیست gifts از endpoint زیر استفاده کنید:
GET استفاده میشود.
احراز هویت
برای استفاده از این API باید یک token معتبر ارسال کنید. این توکن از جدول
safety بررسی میشود.
دو روش پیشنهادی برای ارسال token:
| روش | توضیح | نمونه |
|---|---|---|
| Bearer Token | ارسال توکن در هدر Authorization | Authorization: Bearer YOUR_TOKEN |
| GET Parameter | ارسال توکن در query string | ?token=YOUR_TOKEN |
نمونه درخواست با cURL
در این روش token داخل هدر Authorization ارسال میشود:
curl -X GET "https://api.gemstarbot.xyz/gifts" \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Accept: application/json"
نمونه cURL با توکن در GET:
curl -X GET "https://api.gemstarbot.xyz/gifts?token=YOUR_TOKEN" \ -H "Accept: application/json"
نمونه استفاده با GET
اگر بخواهید مستقیم از طریق URL درخواست بفرستید:
https://api.gemstarbot.xyz/gifts?token=YOUR_TOKEN
نمونه استفاده در PHP:
<?php $url = "https://api.gemstarbot.xyz/gifts?token=YOUR_TOKEN"; $response = file_get_contents($url); $data = json_decode($response, true); print_r($data); ?>
نمونه پاسخ موفق
در صورت معتبر بودن token، پاسخ به این شکل خواهد بود:
{
"status": true,
"data": [
{
"id": "1",
"name": "🏆",
"emoji": "5409008750893734809",
"price": "100.00",
"fee": "1.00"
},
{
"id": "2",
"name": "🌹",
"emoji": "5440911110838425969",
"price": "25.00",
"fee": "1.00"
},
{
"id": "3",
"name": "🎂",
"emoji": "5370999492914976897",
"price": "50.00",
"fee": "2.00"
},
{
"id": "4",
"name": "💝",
"emoji": "5465263910414195580",
"price": "15.00",
"fee": "1.00"
},
{
"id": "5",
"name": "🧸",
"emoji": "5397915559037785261",
"price": "15.00",
"fee": "1.00"
},
{
"id": "6",
"name": "🎁",
"emoji": "5203996991054432397",
"price": "25.00",
"fee": "1.00"
},
{
"id": "7",
"name": "💐",
"emoji": "5395347834314696158",
"price": "50.00",
"fee": "1.00"
},
{
"id": "8",
"name": "💎",
"emoji": "5471952986970267163",
"price": "100.00",
"fee": "1.00"
},
{
"id": "9",
"name": "🚀",
"emoji": "5445284980978621387",
"price": "50.00",
"fee": "1.00"
},
{
"id": "10",
"name": "💍",
"emoji": "5402100905883488232",
"price": "100.00",
"fee": "1.00"
},
{
"id": "11",
"name": "🎁",
"emoji": "5224509179334529299",
"price": "50.00",
"fee": "2.00"
},
{
"id": "12",
"name": "🎁",
"emoji": "5224648868850863664",
"price": "50.00",
"fee": "2.00"
},
{
"id": "13",
"name": "🎁",
"emoji": "5289670279960762852",
"price": "50.00",
"fee": "2.00"
},
{
"id": "14",
"name": "🎁",
"emoji": "5316983759407452675",
"price": "50.00",
"fee": "2.00"
},
{
"id": "15",
"name": "🎄",
"emoji": "5345935030143196497",
"price": "50.00",
"fee": "2.00"
},
{
"id": "16",
"name": "👒🧸",
"emoji": "5379850840691476775",
"price": "50.00",
"fee": "2.00"
},
{
"id": "17",
"name": "🍾",
"emoji": "5370900768796711127",
"price": "50.00",
"fee": "2.00"
}
]
}
فیلدهای خروجی
| فیلد | نوع | توضیح |
|---|---|---|
status |
boolean | وضعیت موفق بودن یا نبودن درخواست |
data |
array | آرایهای از gift ها |
id |
string | شناسه gift |
name |
string | نام یا نماد gift |
emoji |
string | شناسه ایموجی یا asset مربوط به gift |
price |
string / decimal | قیمت gift |
fee |
string / decimal | کارمزد gift |
نمونه خطاها
در بعضی شرایط پاسخ خطا به این شکل خواهد بود:
توکن ارسال نشده:
{
"status": false,
"message": "Token is required"
}
توکن نامعتبر:
{
"status": false,
"message": "Invalid token"
}
•
200 برای پاسخ موفق
•
401 وقتی token ارسال نشده باشد
•
403 وقتی token معتبر نباشد