Integração do desenvolvedor

7stamp REST API

Disponível

O 7stamp Integration API permite que um CRM, plataforma de comércio eletrônico, POS, back-end personalizado ou ferramenta de automação gerencie carteira cartões de fidelidade com o identificador de contato que seu próprio sistema já usa. É a opção universal quando não existe uma integração especializada.

A base API URL é https://api.7loc.com/cards-api. Autentique cada solicitação com uma chave API como um token Bearer. Use a referência vinculada OpenAPI para os esquemas de solicitação e resposta em tempo real antes de construir a lógica de produção.

O que você pode fazer com o API

O API é o lado de gravação da pilha de integração. Use-o sempre que seu próprio software permanecer como a fonte operacional da verdade enquanto 7stamp cuida da camada de fidelidade da carteira.

Emita cartões a partir do seu próprio software

Gere um link de cartão de carteira pessoal para qualquer cliente em seu sistema. Entregue por e-mail, SMS, push ou fluxo no aplicativo. O cliente abre o link e salva o cartão em Apple Wallet ou Google Wallet.

Selos de crédito de qualquer fonte

Quando uma compra é encerrada em seu POS personalizado, quando um pedido on-line é pago em seu site ou quando um serviço é concluído em seu sistema de reservas, ligue para API para selos de crédito. O cartão é atualizado em segundos.

Gerencie vouchers e campanhas

Emita um voucher único para um cliente específico, crie fluxos de recompensa prontos para a campanha e traga o status do voucher de volta aos sistemas que controlam as finanças e a qualidade do serviço.

Integração documentada API operações

Estas são as rotas públicas API atrás do Ações Make e Zapier. Leia o esquema exato na referência API; não infira nomes de campos de um endpoint diferente.

Cartões POST /cards/invite

Crie um cartão de convite

Cria uma nova instalação pessoal URL para um contato externo.

Cartões POST /cards/invite/bulk

Criação de convites de cartão em massa

Cria até 100 links de convite em um lote controlado.

Cartões GET /cards

Encontrar cartões

Pesquisa registros de cartões por identificador de contato externo.

Cartões GET /cards/{user_card_id}

Obtenha detalhes do cartão

Retorna o estado completo de um cartão por seu 7stamp ID interno.

Cartões POST /cards/scan

Digitaliza um cartão

Adiciona carimbos por cartão ID ou External ID e registra a ordem de origem quando fornecido.

Modelos GET /templates

Modelos de lista

Lista modelos de cartão disponíveis para o local de trabalho da chave/profile.

Modelos GET /templates/{template_id}/design

Obter design de modelo

Lê configurações visuais para um cartão conhecido modelo.

Vouchers POST /vouchers/issue

Emitir um voucher

Emite um voucher para o titular do cartão.

Mensagens POST /messages/send

Enviar uma mensagem

Envia push de cartão de carteira e /or conteúdo de e-mail para o proprietário do cartão.

Onde criar e copiar a chave API

Estas são telas 7stamp Admin reais. Abra API & Integrações, adicione uma chave e copie-a em um segredo seguro do lado do servidor ou em uma conexão de automação.

7stamp Admin API & Tela de integrações mostrando o botão Add API Key e a caixa de diálogo Gerar API Chave
Etapa 1 - Selecione API & Integrações na navegação esquerda, abra API Keys, escolha Add API Key, selecione o login de equipe apropriado e gere a chave. Caixa de diálogo
7stamp Admin mostrando uma chave API recém-gerada e seu controle de cópia
Etapa 2 — Copie a nova chave em um gerenciador de senhas, segredo do servidor ou conexão segura Make/Zapier. Não cole-o no código-fonte, em um aplicativo de navegador ou em um ticket de suporte.

Três decisões a serem tomadas antes de codificar

API escopo da chave

Crie a chave em 7stamp Admin em API Integrations → API KeysAdd API Key. Uma chave pertence a um local de trabalho/profile, portanto, crie chaves separadas para desenvolvimento e produção quando a configuração da sua conta permitir. Gire ou revogue o acesso do painel se um segredo for exposto.

Identidade do cliente

External ID é o identificador de contato estável do seu sistema: CRM ID, cliente UUID, número de telefone ou e-mail. Prefira um sistema imutável ID. Opcionalmente, adicione External Source para evitar colisões entre sistemas e para tornar explícita a correlação do webhook.

Seleção de modelo

Quando o perfil possui um modelo ativo, template_id pode ser omitido e 7stamp o seleciona automaticamente. Quando tiver vários templates ativos, passe o template_id pretendido. Leia GET /templates primeiro, em vez de codificar um ID adivinhado.

Solicitação autenticada mínima: crie um convite

Copie isso em sua etapa de automação bash
curl -X POST "https://api.7loc.com/cards-api/cards/invite" \
  -H "Authorization: Bearer YOUR_7STAMP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "crm_contact_8821",
    "external_source": "hubspot",
    "template_id": 42
  }'

Da chave API para uma primeira solicitação bem-sucedida

01

Faça login em 7stamp Admin e crie uma chave: API Integrations → API KeysAdd API Key. Armazene-o em seu gerenciador de segredos, não no código-fonte ou em um aplicativo do lado do cliente.

02

Defina a base URL como https://api.7loc.com/cards-api e adicione Authorization: Bearer seguido pela chave para cada solicitação do lado do servidor.

03

Ligue primeiro para GET /templates. Uma resposta bem-sucedida confirma o token e mostra os modelos disponíveis para esse local de trabalho/profile.

04

Escolha o estável External ID e o opcional External Source do seu próprio sistema. Use exatamente o mesmo par de identidades na lógica de criação, varredura, pesquisa e webhook.

05

Ligue para POST /cards/invite ​​com um contato de teste descartável. Verifique a instalação devolvida URL antes de automatizar a entrega para clientes reais.

06

Adicione POST /cards/scan, voucher ou ações de mensagem somente depois de ter registro, tratamento de erros e uma estratégia segura de nova tentativa/idempotency em seu próprio back-end.

Use a referência API como contrato

A referência pública Swagger/OpenAPI contém o endpoint atual, parâmetro, corpo da solicitação, resposta e esquemas de webhook. O URL interativo é https://api.7loc.com/cards-api/docs e o contrato legível por máquina é https://api.7loc.com/cards-api/openapi.json. Leia-o antes de implementar o tratamento de erros ou adicionar campos opcionais.

Autenticação e segurança da chave

A chave é um segredo do lado do servidor. Não o exponha no JavaScript do navegador, em um pacote de aplicativos móveis, em um formulário público, em capturas de tela, em campos de texto Make/Zapier ou em tickets de suporte. Use um servidor, uma conexão de automação segura ou um gerenciador de segredos. Se a chave for compartilhada acidentalmente, revogue-a ou gire-a em 7stamp Admin e atualize a conexão afetada.

Perguntas frequentes

Onde posso obter um token 7stamp API?

Em 7stamp Admin, vá para API Integrations → API Keys → Add API Key. O token é então enviado no cabeçalho Authorization como Bearer seguido pela chave.

Qual é a base URL e o método de autenticação?

Use https://api.7loc.com/cards-api e envie Authorization: Bearer YOUR_7STAMP_API_KEY em cada solicitação autorizada.

Quando posso omitir template_id?

Somente quando o perfil conectado possui exatamente um modelo de cartão ativo. Se vários modelos estiverem ativos, selecione o template_id correto em GET /templates.

Devo usar API, Make ou Zapier?

Use API para um POS personalizado, back-end, site ou controle total. Use Make para cenários de ramificação visual. Use Zapier para um fluxo de trabalho de ação de gatilho principalmente linear. Todos os três dependem da mesma chave API e do mesmo contrato API.

Próxima etapa

Teste o menor fluxo seguro API primeiro

Crie a chave, ligue para GET /templates, crie um convite para um contato descartável e adicione segredos de produção, registro, novas tentativas e manipulação de webhook em torno da solicitação comprovada.