تست اتصال (ping)
پاتریس یار با GET /wp-json/payava-patris/v1/ping بررسی میکند که سایت در دسترس است و کلید را میپذیرد. پاسخ این endpoint روش دریافت سفارشهای سایت را هم به پاتریس یار میگوید.
این endpoint کی صدا زده میشود؟
با دکمهی «تست اتصال» در پاتریس یار. اگر پاسخ موفق باشد، پاتریس یار پیام «اتصال برقرار است و کلید پذیرفته شد» را نشان میدهد.
پیشنیازها
- مسیرها و احراز هویت در وردپرس پیادهسازی شده باشد.
Endpoint
GET /wp-json/payava-patris/v1/ping
هدرها
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
X-Payava-Key | string | بله | کلید API حساب پاتریس. |
پارامترهای پاسخ
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
ok | boolean | بله | همیشه true. |
plugin | string | خیر | نسخهی پیادهسازی شما، مثل custom-1.0.0. |
site | string | خیر | نام سایت. |
woocommerce | string | خیر | نسخهی ووکامرس (WC_VERSION). |
order_mode | string | بله | pull اگر پاتریس یار سفارشها را از سایت میگیرد، cloud اگر سایت سفارشها را به سرور پاتریس میفرستد. |
پیادهسازی در وردپرس
GET /ping
function my_patris_ping()
{
return [
'ok' => true,
'plugin' => 'my-patris-connector-1.0.0',
'site' => get_bloginfo('name'),
'woocommerce' => defined('WC_VERSION') ? WC_VERSION : null,
'order_mode' => get_option('my_patris_order_mode', 'pull'), // pull | cloud
];
}
نمونه پاسخ موفق
200 OK
{
"ok": true,
"plugin": "custom-1.0.0",
"site": "My Shop",
"woocommerce": null,
"order_mode": "pull"
}
کدهای خطا
| نام | نوع | الزامی | توضیح |
|---|---|---|---|
401 | payava_patris_unauthorized | — | کلید ارسالی با کلید سایت برابر نیست. پاتریس یار میگوید کلید پذیرفته نشد. |
404 | — | — | مسیر روی سایت پیدا نشد. پاتریس یار میگوید مسیر اتصال پیدا نشد و «آدرس سایت» را بررسی کنید. |
نکتهها
- اگر
order_modeبا روش انتخابشده در پاتریس یار یکی نباشد، «تست اتصال» هشدار میدهد. مثلاً اگر در پاتریس یار «دریافت از طریق سرور پاتریس» انتخاب شده ولیorder_modeبرابرcloudنیست. - این endpoint را سبک نگه دارید و در آن به پایگاه داده درخواست سنگین نزنید.