API v1REST · JSON · HTTPS

תיעוד API

ה-REST API של Cardli Rewards מאפשר לשלב חותמות נאמנות, ניהול חברים ומימוש הטבות ישירות באפליקציה או במערכת הקופה שלכם.

כתובת בסיס

https://api.cardli.co.il

אימות

Bearer token (מפתח API)

מגבלת קצב

1,000 בקשות לדקה

אימות

כל בקשת API מחייבת כותרת Authorization עם מפתח ה-API שלכם. את המפתחות תמצאו בהגדרות ← מפתחות API.

Authorization: Bearer lf_live_xxxxxxxxxxxx

השתמשו במפתחות lf_test_ לצורכי פיתוח — הם פונים לסביבת ארגז חול, בלי חותמות או הטבות אמיתיות.

דוגמה: רישום חותמת

בקשה

curl -X POST https://api.cardli.co.il/v1/cards/card_abc123/stamp \
  -H "Authorization: Bearer lf_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "member_id": "mem_xyz789",
    "location_id": "loc_001",
    "amount": 1
  }'

תגובה 200 OK

{
  "id": "txn_aAbBcC",
  "member_id": "mem_xyz789",
  "card_id": "card_abc123",
  "type": "stamp",
  "stamps_before": 4,
  "stamps_after": 5,
  "reward_triggered": false,
  "created_at": "2025-03-28T14:32:00Z"
}

נקודות קצה

חברים

GET/v1/membersרשימת כל חברי מועדון הלקוחות של העסק שלכם.
GET/v1/members/:idשליפת חבר בודד לפי מזהה.
POST/v1/membersיצירת חבר מועדון חדש.
PATCH/v1/members/:idעדכון שדות בפרופיל החבר.
DELETE/v1/members/:idהסרת חבר מהתוכנית שלכם.

כרטיסים

GET/v1/cardsרשימת כל תוכניות כרטיסי המועדון.
GET/v1/cards/:idשליפת תוכנית כרטיס מסוימת.
POST/v1/cards/:id/stampרישום חותמת או ביקור עבור חבר.
POST/v1/cards/:id/redeemמימוש הטבה עבור חבר.

עסקאות

GET/v1/transactionsרשימת כל העסקאות, עם אפשרות סינון.
POST/v1/transactionsרישום עסקה ידנית.

Webhooks

POST/v1/webhooksרישום נקודת קצה של Webhook לקבלת אירועים.
GET/v1/webhooksרשימת כל ה-Webhooks הרשומים.
DELETE/v1/webhooks/:idהסרת Webhook.