راهنما
راهنمای آدرس اختصاصی فروشگاه
اگر فروشگاه شما ووکامرس نیست، یک آدرس بسازید که فهرست محصولات را به این شکل برگرداند. پابلورا فقط میخواند.
درخواست
پابلورا به آدرسی که ثبت کردهاید GET میزند و هدر x-publora-key را با کلید شما میفرستد. کلید اختیاری است، ولی برای آدرسی که عمومی است توصیه میشود.
curl -H "x-publora-key: YOUR_KEY" -H "accept: application/json" https://shop.example.ir/publora/productsشکل پاسخ
یک JSON با currency و فهرست products.
{
"currency": "IRT",
"products": [
{
"id": "1001",
"title": "کیف چرمی دستدوز",
"price": 1250000,
"stock": 7,
"url": "https://shop.example.ir/p/1001",
"image": "https://shop.example.ir/img/1001.jpg",
"variants": [
{ "id": "1001-a", "name": "قهوهای", "price": 1250000, "stock": 4 },
{ "id": "1001-b", "name": "مشکی", "price": 1290000, "stock": 3 }
]
},
{
"id": "1002",
"title": "جاکارتی",
"price": 380000,
"stock": null,
"url": "https://shop.example.ir/p/1002",
"image": ""
}
]
}| فیلد | وضعیت | توضیح |
|---|---|---|
| currency | اختیاری | IRT (تومان، پیشفرض)، IRR (ریال) یا هر کد دیگر. هر محصول میتواند currency خودش را داشته باشد. |
| products[].id | لازم | شناسهٔ یکتا؛ متن یا عدد. |
| products[].title | لازم | نامی که مشتری مینویسد؛ همین برای پیدا کردن محصول به کار میرود. |
| products[].price | لازم | عدد صفر یا بیشتر، بدون جداکننده. محصول بدون قیمت نادیده گرفته میشود و حدس زده نمیشود. |
| products[].stock | اختیاری | عدد صحیح؛ منفی صفر حساب میشود. null یعنی موجودی معلوم نیست و پابلورا «موجودی را از فروشگاه بپرسید» میگوید. |
| products[].url | اختیاری | صفحهٔ محصول. |
| products[].image | اختیاری | آدرس تصویر. |
| products[].variants[] | اختیاری | id، name، price و stock هر نوع. نوعی که قیمت ندارد نادیده گرفته میشود. |
نمونهٔ آماده
این فایل ساده را روی سایت خودتان (مثلاً وردپرس یا هر هاست PHP) بگذارید، کلید را در متغیر PUBLORA_KEY بگذارید و فهرست را از پایگاه دادهٔ خودتان بسازید.
<?php
// publora-products.php: بدون کلید درست، پاسخ ۴۰۱ میدهد.
$key = getenv('PUBLORA_KEY');
if (!$key || !hash_equals($key, $_SERVER['HTTP_X_PUBLORA_KEY'] ?? '')) {
http_response_code(401);
exit;
}
header('content-type: application/json; charset=utf-8');
echo json_encode([
'currency' => 'IRT',
'products' => [[
'id' => '1001',
'title' => 'کیف چرمی دستدوز',
'price' => 1250000,
'stock' => 7,
'url' => 'https://shop.example.ir/p/1001',
'image' => 'https://shop.example.ir/img/1001.jpg',
]],
], JSON_UNESCAPED_UNICODE);قاعدهها و محدودیتها
- آدرس باید با https شروع شود، عمومی باشد و نام کاربری و رمز در خودش نداشته باشد.
- پابلورا فقط درخواست GET میفرستد و هیچچیز در فروشگاه شما تغییر نمیدهد.
- اگر کلید ثبت کرده باشید، در هدر x-publora-key فرستاده میشود؛ پاسخ ۴۰۱ یا ۴۰۳ یعنی کلید درست نیست.
- پاسخ باید ۲۰۰ باشد، حداکثر ۵ مگابایت و در ۳۰ ثانیه. هدایت به آدرس دیگر دنبال نمیشود.
- همهٔ فهرست در یک پاسخ برگردد؛ صفحهبندی پشتیبانی نمیشود.