API & Integrations

14. API & Integrations

يحتوي قسم API & Integrations على أدوات لربط 7Stamp برمجيًا مع أنظمتك الخارجية مثل CRM و POS و ERP وأدوات التحليلات وروبوتات المراسلة.

API Keys

الصفحة الرئيسية في هذا القسم هي قائمة مفاتيح API. الأعمدة هي:

• Name — اسم المفتاح (وغالبًا يطابق اسم Staff المرتبط به).
• Login — حساب Staff Login المرتبط بالمفتاح.
• API Key — المفتاح نفسه (يبدأ بـ 7loc_sc_...، ومخفي افتراضيًا، ويمكن نسخه بنقرة واحدة).
• Status — Active.
• 🔄 — إعادة إنشاء المفتاح.
• 🗑️ — حذف المفتاح.

إنشاء مفتاح API

اضغط + ADD API KEY — وستفتح نافذة Generate API Key:

• Scanner — قائمة منسدلة لاختيار Staff Login الذي سيرتبط به المفتاح (يمكن لكل Staff أن يملك مفتاحًا واحدًا).
• Buttons CANCEL / GENERATE.

بعد الضغط على GENERATE يتم إنشاء المفتاح ويظهر في القائمة. انسخه فورًا، لأن المفتاح الكامل قد لا يُعرض لك مرة أخرى.

ما الذي يمكنك تنفيذه عبر API

• إصدار Card لعميل عبر البريد الإلكتروني أو الهاتف.
• إضافة ختم لعميل محدد.
• إصدار Voucher (قالب جاهز أو مخصص، مع Redeem Code).
• Redeem a Voucher (إذا كنت تعمل عبر POS الخاص بك).
• قراءة حالة البطاقة والتقدم والسجل.
• الاشتراك في Webhooks لتلقي الأحداث في الوقت الحقيقي.

Webhooks

ترسل Webhooks أحداث البطاقة إلى نظام خارجي. والأحداث المدعومة هي (راجع event glossary):

• SCAN, DELIVERY_INSERT.
• REWARD_EARNED, LOTTERY_WIN.
• VOUCHER_ISSUED, ADMIN_VOUCHER_ISSUE, VOUCHER_REDEEMED.
• CARD_JOINED, CARD_ADDED_TO_WALLET, CARD_REMOVED_FROM_WALLET.
• CARD_CAMPAIGN, BIRTHDAY_GREETING.

Webhook payload example

{
  "entity": "card_event",
  "action": "created",
  "entity_id": 707,
  "event_id": "8f05e58decec48e09d328f0edebbacf6",
  "profile_id": 2,
  "profile_name": "Your Business",
  "profile_lang": "en",
  "data": {
    "event_type": "SCAN",
    "scanned_at": "2026-10-01T09:19:24.179424",
    "user_card_id": 10,
    "card_template_id": 14,
    "card_template_name": "Collect your stamps!",
    "stamps_added": 3,
    "stamps_before": 1,
    "stamps_after": 4,
    "amount": null,
    "external_order_id": "ORDER-1001",
    "workplace": { "id": 4, "name": "Bar Counter" },
    "device_type": null,
    "external_id": "odoo_contact_8821",
    "external_source": "odoo",
    "issued_vouchers": [
      {
        "id": 174,
        "unique_code": "100425813507",
        "stamp_number": 4,
        "issued_at": "2026-10-01T09:19:24.191836",
        "expires_at": "2027-01-01T23:59:59",
        "status": "ACTIVE",
        "voucher_template_id": 58,
        "voucher_description": "Free coffee",
        "voucher_image_url": "https://..."
      }
    ],
    "achieved_goals": [],
    "user": {
      "id": 2,
      "name": "Anna",
      "full_name": "Anna Smith",
      "email": "anna@example.com",
      "telegram_chat_id": null,
      "telegram_username": null,
      "whatsapp_phone": null,
      "birth_date": null
    }
  }
}

Ready-made POS integrations

• Poster — تكامل جاهز، ويمكن ربطه خلال بضع نقرات.
• Serve — تكامل جاهز.
• Other tills — تُنفّذ عند الطلب. وهي مجانية إذا كانت ممكنة تقنيًا (أي إذا كان نظام الكاشير لديك يوفّر API مفتوحًا أو Webhooks).

Messenger broadcasts via 7loc.com

لبث الرسائل عبر WhatsApp و Telegram و Viber، يتم استخدام تكامل 7loc.com. وبعد تفعيله، تظهر قناة “messengers” داخل Campaigns إلى جانب PUSH و Email.

سيناريوهات بلا كود: Zapier وMake

تعمل 7Stamp API + Webhooks مع Zapier و Make (Integromat)، ما يتيح لك بناء workflows من دون كتابة كود:

• “عند VOUCHER_REDEEMED — أضِف وسمًا (tag) في Mailchimp”.
• “عند REWARD_EARNED — أرسِل إشعارًا إلى Slack”.
• “عند BIRTHDAY_GREETING — أنشِئ مهمة في CRM”.

---