پرش به مطلب اصلی

تست اتصال (ping)

پاتریس یار با GET /patris-yar/ping بررسی می‌کند که سایت در دسترس است و کلید را می‌پذیرد. پاسخ این endpoint روش دریافت سفارش‌های سایت را هم به پاتریس یار می‌گوید.

این endpoint کی صدا زده می‌شود؟​

با دکمه‌ی «تست اتصال» در پاتریس یار. اگر پاسخ موفق باشد، پاتریس یار پیام «اتصال برقرار است و کلید پذیرفته شد» را نشان می‌دهد.

پیش‌نیازها​

Endpoint​

GET /patris-yar/ping

هدرها​

نامنوعالزامیتوضیح
X-Payava-Keystringبلهکلید API حساب پاتریس.

پارامترهای پاسخ​

نامنوعالزامیتوضیح
okbooleanبلههمیشه true.
pluginstringخیرنسخه‌ی پیاده‌سازی شما، مثل custom-1.0.0.
sitestringخیرنام سایت.
woocommercestringخیربرای سایت اختصاصی null بفرستید.
order_modestringبلهpull اگر پاتریس یار سفارش‌ها را از سایت می‌گیرد، cloud اگر سایت سفارش‌ها را به سرور پاتریس می‌فرستد.

نمونه درخواست و پیاده‌سازی​

تست ping
curl https://shop.example.com/patris-yar/ping \
-H "X-Payava-Key: YOUR_API_KEY"

نمونه پاسخ موفق​

200 OK
{
"ok": true,
"plugin": "custom-1.0.0",
"site": "My Shop",
"woocommerce": null,
"order_mode": "pull"
}

کدهای خطا​

نامنوعالزامیتوضیح
401payava_patris_unauthorized—کلید ارسالی با کلید سایت برابر نیست. پاتریس یار می‌گوید کلید پذیرفته نشد.
404——مسیر روی سایت پیدا نشد. پاتریس یار می‌گوید مسیر اتصال پیدا نشد و «آدرس API» را بررسی کنید.

نکته‌ها​

  • اگر order_mode با روش انتخاب‌شده در پاتریس یار یکی نباشد، «تست اتصال» هشدار می‌دهد. مثلاً اگر در پاتریس یار «دریافت از طریق سرور پاتریس» انتخاب شده ولی order_mode برابر cloud نیست.
  • این endpoint را سبک نگه دارید و در آن به پایگاه داده درخواست سنگین نزنید.