API & Integrations

14. API & Integrations

Розділ API & Integrations містить інструменти для програмної інтеграції 7Stamp з вашими зовнішніми системами — CRM, POS, ERP, аналітикою, messenger bots.

API Keys

Головна сторінка розділу — список API key. Колонки:

• Name — назва ключа (зазвичай збігається з прив’язаним Staff name).
• Login — Staff login, до якого прив’язано ключ.
• API Key — сам ключ (починається з 7loc_sc_..., прихований за замовчуванням, копіюється одним кліком).
• Status — Active.
• 🔄 — перевипустити ключ.
• 🗑️ — видалити ключ.

Створення API key

Натисніть + ADD API KEY — відкриється popup Generate API Key:

• Scanner — dropdown для вибору Staff Login, до якого буде прив’язано ключ (один Staff може мати один ключ).
• Кнопки CANCEL / GENERATE.

Після GENERATE ключ створюється і з’являється в списку. Скопіюйте його одразу — повний ключ може більше не бути показаний.

Що можна робити через API

• Issue a card клієнту за email/phone.
• Add a stamp конкретному клієнту.
• Issue a voucher (шаблонний або custom, з Redeem Code).
• Redeem a voucher (якщо ви працюєте через власний POS).
• Read state картки, прогрес, історію.
• Subscribe to Webhooks, щоб отримувати події в реальному часі.

Webhooks

Webhooks надсилають card events у зовнішню систему. Підтримуються (див. 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

{
  "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
    }
  }
}

Готові POS integrations

• Poster — готова інтеграція, підключається в кілька кліків.
• Serve — готова інтеграція.
• Інші каси — робляться на запит. Безкоштовно, якщо технічно можливо (тобто ваша каса віддає відкритий API або Webhooks).

Розсилки в месенджери через 7loc.com

Для WhatsApp, Telegram, Viber-розсилок підключається інтеграція з 7loc.com. Після активації в Campaigns з’являється канал “messengers” поруч із PUSH та Email.

No-code сценарії: Zapier і Make

7Stamp API + Webhooks працюють із Zapier і Make (Integromat), дозволяючи будувати сценарії без коду:

• “Коли VOUCHER_REDEEMED — додати tag у Mailchimp”.
• “Коли REWARD_EARNED — надіслати notification у Slack”.
• “Коли BIRTHDAY_GREETING — створити task у CRM”.

---