Saltar para o conteúdo
Navegar na documentação

Referência API

Kamba Email

Domínios, envio e templates

Já tens uma chave? Personaliza os exemplos temporariamente

Opcional. A chave ficará visível nos exemplos de código. Fica apenas na memória desta página: sem guardar nem enviar. Limpa-a antes de partilhar o ecrã ou capturas.

Os exemplos usam valores ilustrativos. Para enviar, cria uma conta e uma chave API e aguarda a aprovação do Sender ID.

$ Gerar Chave

Mensagens transacionais

Kamba Email

Envia emails transacionais pela API com domínio próprio, histórico, supressões automáticas e volume mensal separado dos créditos SMS.

POST/email/send

Envia um email em produção. Exige domínio verificado e volume mensal disponível.

domain_iduuidobrigatório

Domínio verificado na conta

from_localstringobrigatório

Parte antes de @, por exemplo notificacoes

from_namestringopcional

Nome apresentado ao destinatário

tostringobrigatório

Um destinatário por pedido

subjectstringobrigatório

Assunto até 200 caracteres

htmlstringopcional

Conteúdo HTML; usa html ou text

textstringopcional

Conteúdo em texto simples; usa html ou text

curl -X POST https://api.kambasms.ao/email/send \
  -H "X-API-Key: SUA_API_KEY" -H "Content-Type: application/json" \
  -H "Idempotency-Key: pedido-123-email" \
  -d '{"domain_id":"UUID_DO_DOMINIO","from_local":"notificacoes","from_name":"Minha Loja","to":"cliente@exemplo.ao","subject":"Pedido confirmado","html":"<h1>Pedido confirmado</h1>"}'
POST/email/sandbox/send

Simula estados previsíveis sem contactar o fornecedor e sem consumir volume.

tostringobrigatório

Usa delivered, bounced, complained, opened, clicked ou failed antes de @kambasms.test

subjectstringobrigatório

Assunto do teste

curl -X POST https://api.kambasms.ao/email/sandbox/send \
  -H "X-API-Key: SUA_API_KEY" -H "Content-Type: application/json" \
  -d '{"to":"delivered@kambasms.test","subject":"Teste Kamba Email"}'
POST/email/templates

Cria um template reutilizável com variáveis no formato {{nome}}.

keystringobrigatório

Chave única, por exemplo pedido_confirmado

namestringobrigatório

Nome visível no dashboard

subjectstringobrigatório

Assunto, com variáveis opcionais

htmlstringopcional

HTML do email

textstringopcional

Alternativa em texto simples

curl -X POST https://api.kambasms.ao/email/templates \
  -H "X-API-Key: SUA_API_KEY" -H "Content-Type: application/json" \
  -d '{"key":"pedido_confirmado","name":"Pedido confirmado","subject":"Pedido {{pedido}} confirmado","text":"Olá {{nome}}, o pedido {{pedido}} foi confirmado."}'
POST/email/bulk

Coloca até 500 destinatários numa fila processada em segundo plano. Cada destinatário enviado consome uma unidade do volume mensal.

domain_iduuidobrigatório

Domínio verificado

template_iduuidobrigatório

Template ativo

recipientsarrayobrigatório

Objetos com email e variables

curl -X POST https://api.kambasms.ao/email/bulk \
  -H "X-API-Key: SUA_API_KEY" -H "Content-Type: application/json" \
  -H "Idempotency-Key: campanha-setembro-01" \
  -d '{"name":"Confirmações","domain_id":"UUID_DO_DOMINIO","template_id":"UUID_DO_TEMPLATE","from_local":"notificacoes","recipients":[{"email":"ana@exemplo.ao","variables":{"nome":"Ana","pedido":"123"}}]}'

Gestão: domínios por GET /email/overview, POST /email/domains e POST /email/domains/:id/verify; templates por PATCH/DELETE /email/templates/:id e POST /email/templates/:id/render; bulk por GET /email/bulk/:id e POST /email/bulk/:id/cancel. Usa Idempotency-Key nos envios para repetir pedidos em segurança. Bounces e complaints entram automaticamente nas supressões.