الانتقال إلى المحتوى
LoyVue المطورون
الأدلة

البدء

ما الذي تقدمه واجهة برمجة نقاط البيع والمسار الذي يتبعه نظام نقطة البيع.

تتيح واجهة نقاط البيع في LoyVue لنظام نقطة البيع تشغيل برنامج ولاء دون شاشة ثانية: يكسب العملاء مع كل طلب مدفوع ويستبدلون مكافآتهم عند الصندوق. إنها واجهة REST تتعامل بـ JSON، وتستخدم رموز حالة HTTP القياسية، وتُوقّع بمفتاح API.

الرابط الأساسي
https://api.loyvue.com/v1

ما يحتاج نظام نقطة البيع إلى فعله

  1. ابحث عن العميل برقم الجوال أو الاسم، وأضفه إن كان جديدًا. مزامنة العملاء
  2. اربط العميل بالطلب قبل دفعه، فالطلب بلا عميل لا يكسب.
  3. أبلغ عن الطلب عند دفعه، ومرة أخرى عند إلغائه أو استرداده. الكسب
  4. دع الكاشير يُدخل رمز المكافأة ويتحقق منه ويطبقه على الطلب ثم يستبدله بعد تسوية الطلب. الاستبدال

مسار المكافأة عند الصندوق

  1. يعرض العميل رمز مكافأته (مثل RW-7KQ2XP) على بطاقة المحفظة.
  2. يكتبه الكاشير مع رقم جوال العميل، ويستدعي نظامك POST /v1/rewards/check.
  3. تبيّن الإجابة ما تمنحه المكافأة: منتجات محددة مجانًا، أو مكافأة مخصصة يطبقها الكاشير يدويًا.
  4. عند دفع الطلب، يستدعي نظامك POST /v1/rewards/redeem ويبلغ عن الطلب كالمعتاد.

الترويسات

أرسل هذه مع كل طلب:

Authorization: Bearer rf_live_YOUR_KEY
Accept: application/json
Content-Type: application/json

أضف ترويسة locale (en أو ar) لتصلك الرسائل بتلك اللغة.