مستندات API: تایید و انجام سفارش

اطلاعات پایه

POST

/giftcard/confirm

نام API: تایید سفارش
آدرس پایه: /giftcard/confirm
متد: POST

پارامترهای درخواست

هدرها

کلید	مقدار	توضیحات
Authorization	Bearer {token}	توکن احراز هویت
Content-Type	application/json	نوع محتوای درخواست

بدنه درخواست

پارامتر	نوع	اجباری	توضیحات
order_id	string	بله	شناسه سفارش

پاسخ‌های ممکن

موفقیت (200 OK)

				
					{
  "order_id": "ORDER-123",
  "status": "processing",
  "message": "پرداخت با موفقیت انجام شد."
}

خطاها

400 Bad Request - پارامترهای ناقص

				
					{
  "code": "rest_missing_parameters",
  "message": "شناسه سفارش الزامی است",
  "data": {
    "status": 400
  }
}

404 Not Found - سفارش یافت نشد

				
					{
  "error": "سفارش یافت نشد",
  "order_id": "ORDER-123"
}

400 Bad Request - وضعیت نامعتبر

				
					{
  "error": "وضعیت سفارش نامعتبر است",
  "current_status": "pending",
  "required_status": "processing"
}

400 Bad Request - سفارش منقضی شده

				
					{
  "error": "سفارش منقضی شده است",
  "expired_at": "2024-03-20T12:00:00Z"
}

نکات مهم

سفارش باید در وضعیت "pending" باشد سفارش‌های منقضی شده قابل تایید نیستند

کلیدهای لایسنس پس از تایید سفارش قابل استفاده هستند

مثال‌های کد

cURL

				
					curl -X POST \
  '{base_url}/giftcard/confirm' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_id": "ORDER-123"
  }'

PHP

				
					$ch = curl_init('{base_url}/giftcard/confirm');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer {token}',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'order_id' => 'ORDER-123'
]));

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);

Python

				
					import requests

headers = {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
}

data = {
    'order_id': 'ORDER-123'
}

response = requests.post('{base_url}/giftcard/confirm',
    headers=headers,
    json=data)
data = response.json()

Node.js

				
					const axios = require("axios");

const response = await axios.post("{base_url}/giftcard/confirm", {
  order_id: "ORDER-123"
}, {
  headers: {
    Authorization: "Bearer {token}",
    "Content-Type": "application/json"
  }
});

const data = response.data;