API Reference / v1نسخه پایدار

وب‌سرویس گیفت سیتی

محصولات را دریافت کنید، سفارش بسازید، نتیجه تحویل را پیگیری کنید و موجودی کیف پول را از یک API مبتنی بر JSON مدیریت کنید.

شروع اتصال دریافت کلید

Base URL

https://gift30t.ir/api/v1

هدر احراز هویت

X-API-KEY: YOUR_API_KEY

فرمت ارتباط

HTTPS/JSON/UTF-8

مسیر پیشنهادی اتصال

برای اولین اتصال، این سه مرحله را به ترتیب انجام دهید.

راهنمای کامل

1
ساخت API Key
کلید اختصاصی و محدودیت IP را از پنل تنظیم کنید.
2
دریافت محصول
شناسه محصول، منطقه، قیمت و فیلدهای الزامی را بخوانید.
3
ثبت و پیگیری سفارش
سفارش را ثبت و تا دریافت نتیجه تحویل پیگیری کنید.

اولین درخواست

کلید واقعی خود را جایگزین کنید. کلید API را داخل کد سمت مرورگر یا مخزن عمومی قرار ندهید.

دریافت صفحه اول محصولاتbash

curl --request GET \
  --url "https://gift30t.ir/api/v1/products?page=1&pageSize=10" \
  --header "Accept: application/json" \
  --header "X-API-KEY: YOUR_API_KEY"

مرجع endpointها

مسیر مورد نظر را انتخاب کنید تا پارامترها و نمونه پاسخ آن را ببینید.

محصولات

دریافت کاتالوگ، دسته‌بندی، قیمت و فیلدهای مورد نیاز.

GET/products

GET/products/:id

GET/products/categories

سفارش‌ها

ثبت سفارش، مشاهده تاریخچه و دریافت اطلاعات تحویل.

POST/orders

GET/orders

GET/orders/:id

کیف پول

بررسی موجودی و مشاهده تراکنش‌های حساب API.

GET/wallet/balance

GET/wallet/transactions

GET/wallet/transactions/:id

قبل از رفتن به محیط عملیاتی

کلید API فقط در سرور نگهداری شود.
خطاهای 401، 403، 429 و 5xx مدیریت شوند.
reference سفارش در دیتابیس شما ذخیره شود.
پاسخ نهایی سفارش از endpoint جزئیات خوانده شود.