مستندات وبسرویس
(v1.0)راهنمای شروع سریع
برای شروع استفاده از API گیفت سیتی، شما نیاز به دریافت یک کلید API از پنل کاربری خود دارید. با استفاده از این کلید، میتوانید به تمام امکانات API دسترسی داشته باشید.
۱. دریافت کلید API
برای دریافت کلید API، مراحل زیر را دنبال کنید:
- وارد پنل کاربری خود شوید
- به بخش "API" مراجعه کنید
- روی دکمه "ایجاد کلید API" کلیک کنید
- کلید API تولید شده را در مکانی امن ذخیره کنید
۲. دریافت لیست محصولات
برای مشاهده محصولات قابل دسترس، میتوانید از اندپوینت زیر استفاده کنید:
// نمونه درخواست با JavaScript
const fetchProducts = async () => {
try {
const response = await fetch('https://gift30t.com/api/v1/products', {
method: 'GET',
headers: {
'X-API-KEY': 'YOUR_API_KEY',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);
} catch (error) {
console.error('خطا در دریافت محصولات:', error);
}
}
۳. ثبت سفارش
برای ثبت سفارش جدید، از اندپوینت زیر استفاده کنید:
// نمونه سفارش محصول با JavaScript
const orderProduct = async () => {
try {
const response = await fetch('https://gift30t.com/api/v1/orders', {
method: 'POST',
headers: {
'X-API-KEY': 'YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
products: [
{
productId: 123,
regionPropertyId: 456,
quantity: 1
}
],
requiredFields: {
"123": [
{
fieldId: 1,
value: "example@gmail.com"
}
]
}
})
});
const data = await response.json();
console.log(data);
} catch (error) {
console.error('خطا در ثبت سفارش:', error);
}
}
۴. مدیریت پرداختها
API گیفت سیتی به طور خودکار از موجودی کیف پول شما برای پرداخت سفارشها استفاده میکند. اطمینان حاصل کنید که کیف پول شما همیشه شارژ است.
نکته مهم
برای جلوگیری از اختلال در سرویسدهی، میتوانید اعلانهای کمبود موجودی را در پنل کاربری خود فعال کنید.
۵. مدیریت خطاها
همه پاسخهای API در قالب JSON و با فرمت یکسان برگردانده میشوند. در صورت بروز خطا، کد و پیام مناسب دریافت خواهید کرد.
{
"status": "error",
"code": 1004,
"message": "موجودی کیف پول کافی نیست",
"meta": {
"currentBalance": 50000,
"requiredAmount": 120000
}
}
آماده استفاده از API
اکنون شما آماده استفاده از API گیفت سیتی هستید! برای اطلاعات بیشتر در مورد هر اندپوینت، به بخش مربوطه در مستندات مراجعه کنید.