Back

للمطورين

Connect loyalty to your POS

A clear REST API and signed webhooks to add points and register customers at checkout.

curl -X POST https://api.walaay.sa/v1/stores/{storeId}/transactions/earn \
  -H "Authorization: Bearer $WALAAY_TOKEN" \
  -H "Idempotency-Key: order_10231" \
  -H "Content-Type: application/json" \
  -d '{
    "cardPublicCode": "WL-RST-4821",
    "purchaseAmountHalalas": 4500
  }'

القدرات

واجهة مبنية للاستخدام في الإنتاج

01

Public REST API

Add and redeem points and register customers from your system.

02

Signed webhooks

Instant events for every loyalty action with automatic retries.

03

Duplicate-safe

An idempotency key prevents awarding points twice during network interruptions.

04

Ready integrations

Foodics, Odoo, Shopify, WooCommerce, and custom cashier systems.

05

Sandbox environment

Test keys to validate the flow before production.

06

Clear limits

Published usage limits and enterprise SLAs.

نقاط النهاية

أهم مسارات الواجهة

POST/v1/auth/loginتسجيل الدخول والحصول على رمز الوصول
GET/v1/stores/mineمتاجر الحساب الحالي
POST/v1/stores/:storeId/cards/issueإصدار بطاقة لعميل
POST/v1/stores/:storeId/transactions/earnإضافة نقاط أو ختم
POST/v1/stores/:storeId/transactions/redeemاستبدال مكافأة
GET/v1/cards/:publicCodeقراءة بطاقة برمزها العام
GET/v1/stores/:storeId/statsإحصاءات المتجر

Webhooks

أحداث فورية موقّعة

card.issuedعند إصدار بطاقة جديدة لعميل
transaction.earnedعند إضافة نقاط أو ختم
transaction.redeemedعند استبدال مكافأة
reward.unlockedعند اكتمال هدف الأختام أو النقاط
subscription.updatedعند تغيير باقة المتجر
كل طلب موقّع بترويسة X-Walaay-Signature (HMAC-SHA256)، وإعادة المحاولة تتم تلقائياً بتباعد متزايد. استخدم Idempotency-Key لمنع تكرار منح النقاط.

التكاملات

يعمل مع الأنظمة التي تستخدمها

FoodicsOdooShopifyWooCommerceSallaZidCustom POSZapier