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

اتصال سایت اختصاصی به پاتریس یار

این بخش برای سایت‌هایی است که با وردپرس و ووکامرس ساخته نشده‌اند. با پیاده‌سازی چند endpoint ساده روی سایت خود، پاتریس یار سفارش‌های سایت را به پاتریس می‌برد و قیمت و موجودی کالاها را از پاتریس به سایت می‌فرستد.

پاتریس یار با سایت من چه کار می‌کند؟​

پاتریس یار برنامه‌ای است که روی رایانه‌ی فروشگاه و کنار نرم‌افزار حسابداری پاتریس نصب می‌شود. برای سایت‌های اختصاصی، اتصال «سایت اختصاصی (REST API)» در پاتریس یار وجود دارد. برنامه‌نویس سایت endpointهای زیر را زیر مسیر ثابت /patris-yar پیاده‌سازی می‌کند؛ مثلاً https://shop.example.com/patris-yar/orders. این پیشوند جلوی تداخل با مسیرهای خود سایت را می‌گیرد.

اگر سایت شما وردپرس و ووکامرس است، به این بخش نیازی ندارید. افزونه‌ی پاتریس یار همه‌ی این کارها را انجام می‌دهد؛ راهنمای آن در افزونه‌ی وردپرس پاتریس یار آمده است.

کارجهتendpoint روی سایت شما
تست اتصال و کلیدپاتریس یار به سایتGET /patris-yar/ping
دریافت سفارش‌های جدیدپاتریس یار به سایتGET /patris-yar/orders
خواندن دوباره‌ی یک سفارشپاتریس یار به سایتGET /patris-yar/orders/:id
اعلام دریافت سفارش‌هاپاتریس یار به سایتPOST /patris-yar/orders/delivered
اعلام وضعیت سفارش در پاتریسپاتریس یار به سایتPOST /patris-yar/orders/:id/ack
ارسال قیمت و موجودی کالاهاپاتریس یار به سایتPOST /patris-yar/products
مای پاتریس: تستپاتریس یار به سایتGET /patris-yar/mypatris/summary
مای پاتریس: اشخاص و ماندهپاتریس یار به سایتPOST /patris-yar/mypatris/persons
مای پاتریس: صورت‌حسابپاتریس یار به سایتPOST /patris-yar/mypatris/statements
ارسال سفارش به سرور پاتریس (اختیاری)سایت به سرور پاتریسPOST /api/site/v1/orders
بررسی کلید با سرور پاتریس (اختیاری)سایت به سرور پاتریسPOST /api/site/v1/verify

مسیرهای جدول به آدرسی که در پاتریس یار وارد می‌کنید اضافه می‌شوند. مثلاً با آدرس https://shop.example.com، مسیر GET /patris-yar/ping یعنی GET https://shop.example.com/patris-yar/ping. جزئیات در صفحه‌ی مسیرها و احراز هویت آمده است.

سفارش‌ها از چه راهی به پاتریس می‌رسند؟​

دو روش وجود دارد و در پاتریس یار برای هر سایت یکی را انتخاب می‌کنید:

  • دریافت مستقیم از همین اتصال (pull): پاتریس یار هر چند دقیقه GET /patris-yar/orders را صدا می‌زند. ساده‌ترین روش است و فقط به endpointهای سایت نیاز دارد.
  • دریافت از طریق سرور پاتریس (cloud): سایت هر سفارش جدید را به سرور پاتریس می‌فرستد و پاتریس یار سفارش را از سرور می‌گیرد. بار درخواست‌های دوره‌ای روی سایت کمتر می‌شود. این روش فقط روی ویندوز ۱۰ و ۱۱ کار می‌کند و باید برای حساب پاتریس فعال باشد. جزئیات در ارسال سفارش به سرور پاتریس.

در هر دو روش، endpointهای قیمت و موجودی، اعلام وضعیت و دریافت مستقیم سفارش‌ها باید روی سایت پیاده‌سازی شوند.

چه چیزهایی لازم است؟​

  • کلید API پاتریس (با پیشوند ppk_) که پشتیبانی پایاوا برای حساب پاتریس شما می‌سازد.
  • اشتراک فعال و امکان «فروشگاه اینترنتی» برای حساب پاتریس. برای مای پاتریس، امکان «مای پاتریس» هم لازم است.
  • آدرس HTTPS سایت که از رایانه‌ی فروشگاه در دسترس باشد. درخواست‌ها از رایانه‌ی فروشگاه ارسال می‌شوند، نه از سرور پایاوا.
  • نسخه‌ای از پاتریس یار که اتصال «سایت اختصاصی (REST API)» را دارد، روی رایانه‌ی فروشگاه.

ترتیب پیشنهادی پیاده‌سازی​

  1. مسیرها و احراز هویت و GET /patris-yar/ping را بسازید.
  2. قالب سفارش را بخوانید و GET /patris-yar/orders، GET /patris-yar/orders/:id و POST /patris-yar/orders/delivered را بسازید.
  3. POST /patris-yar/orders/:id/ack و POST /patris-yar/products را بسازید.
  4. اگر مای پاتریس لازم است، سه endpoint مای پاتریس را اضافه کنید.
  5. طبق اتصال در پاتریس یار و تست سایت را در پاتریس یار ثبت و آزمایش کنید.
  6. در صورت نیاز، ارسال سفارش به سرور پاتریس را اضافه کنید.

خطاها باید با قالبی برگردند که پاتریس یار بفهمد. این قالب در قالب خطاها آمده است.