مستندات وبسرویس
(v1.0)احراز هویت
برای استفاده از API گیفت سیتی، نیاز به احراز هویت با استفاده از کلید API دارید. این کلید در تمام درخواستها باید ارسال شود تا بتوانید به منابع API دسترسی داشته باشید.
دریافت کلید API
کلید API را میتوانید از پنل کاربری خود در بخش API دریافت کنید. پس از ورود به پنل کاربری، روی گزینه API کلیک کرده و سپس روی "ایجاد کلید API" کلیک کنید.
توجه
کلید API شما معادل نام کاربری و رمز عبور شماست. آن را در اختیار دیگران قرار ندهید و در محل امنی ذخیره کنید. در صورت افشای کلید API، میتوانید آن را در پنل کاربری خود غیرفعال کنید.
استفاده از کلید API
برای احراز هویت، کلید API خود را در هدر X-API-KEY
قرار دهید.
// نمونه استفاده از کلید API در JavaScript
fetch('https://gift30t.com/api/v1/products', {
method: 'GET',
headers: {
'X-API-KEY': 'YOUR_API_KEY',
'Content-Type': 'application/json'
}
})
// نمونه استفاده از کلید API در PHP
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://gift30t.com/api/v1/products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"X-API-KEY: YOUR_API_KEY",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
curl_close($curl);
# نمونه استفاده از کلید API در Python
import requests
url = "https://gift30t.com/api/v1/products"
headers = {
"X-API-KEY": "YOUR_API_KEY",
"Content-Type": "application/json"
}
response = requests.get(url, headers=headers)
data = response.json()
خطاهای احراز هویت
در صورت بروز مشکل در احراز هویت، پاسخهای خطای زیر را دریافت خواهید کرد:
کد خطا | پیام | توضیحات |
---|---|---|
1001 | کلید API ارائه نشده است | هدر X-API-KEY در درخواست وجود ندارد |
1001 | کلید API نامعتبر است | کلید API ارائه شده معتبر نیست یا منقضی شده است |
{
"status": "error",
"code": 1001,
"message": "کلید API نامعتبر است"
}
محدودیت درخواست
هر کلید API محدود به 60 درخواست در هر دقیقه است. در صورت فراتر رفتن از این محدودیت، با خطای کد 1002 مواجه خواهید شد. در این صورت، باید چند لحظه صبر کنید و سپس مجدداً تلاش کنید.
هدر X-Rate-Limit-Remaining
در پاسخهای API نشاندهنده تعداد درخواستهای باقیمانده در بازه زمانی فعلی است.