API & Integrations

14. API & Integrations

A seção API & Integrations contém ferramentas para integração programática do 7Stamp com seus sistemas externos — CRM, POS, ERP, analytics, bots de mensageiros.

API Keys

A página principal da seção é a lista de chaves API. Colunas:

• Name — nome da chave (geralmente corresponde ao nome do Staff vinculado).
• Login — o Staff login ao qual a chave está vinculada.
• API Key — a chave em si (começa com 7loc_sc_..., oculta por padrão, copiável com um clique).
• Status — Active.
• 🔄 — regenerar a chave.
• 🗑️ — excluir a chave.

Criar uma API key

Toque em + ADD API KEY — o popup Generate API Key abre:

• Scanner — dropdown para escolher o Staff Login ao qual a chave será vinculada (um Staff pode ter uma chave).
• Botões CANCEL / GENERATE.

Depois de GENERATE, a chave é criada e aparece na lista. Copie-a imediatamente — a chave completa pode não ser mostrada novamente.

O que você pode fazer via API

• Emitir um cartão para um cliente por email/telefone.
• Adicionar um selo a um cliente específico.
• Emitir um voucher (por template ou customizado, com Redeem Code).
• Resgatar um voucher (se você trabalha via seu próprio POS).
• Ler o estado do cartão, progresso, histórico.
• Assinar Webhooks para receber eventos em tempo real.

Webhooks

Webhooks enviam eventos de cartão para um sistema externo. Suportados (veja o glossário de eventos):

• 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.

Exemplo de payload de Webhook

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

Integrações POS prontas

• Poster — integração pronta, conecta em poucos cliques.
• Serve — integração pronta.
• Other tills — feitas sob solicitação. Grátis se tecnicamente viável (ou seja, se seu caixa expõe uma API aberta ou Webhooks).

Broadcasts em mensageiros via 7loc.com

Para broadcasts em WhatsApp, Telegram, Viber, a integração 7loc.com é conectada. Quando ativa, o canal “messengers” fica disponível em Campaigns ao lado de PUSH e Email.

Cenários no-code: Zapier e Make

7Stamp API + Webhooks funcionam com Zapier e Make (Integromat), permitindo criar cenários sem código:

• “Quando VOUCHER_REDEEMED — adicionar uma tag no Mailchimp”.
• “Quando REWARD_EARNED — enviar uma notificação para o Slack”.
• “Quando BIRTHDAY_GREETING — criar uma tarefa no CRM”.

---