Skip to main content
No Spark, Desenvolvedores é a área em Configurações → Desenvolvedores onde a organização liga o acesso programático ao CRM e administra as credenciais usadas pelo gateway público. Não é um “modo” que muda a interface do dia a dia do time de atendimento: é um interruptor de API e um cofre de chaves para integrações, formulários públicos, ERPs e scripts.

Para que serve

  • Permitir que sistemas externos chamem endpoints oficiais (REST + JSON) em nome da organização, não de um usuário específico.
  • Pausar todas as integrações de uma vez desligando o ambiente, sem apagar as chaves já criadas.
  • Separar credenciais por projeto (produção, homologação, parceiro) usando várias chaves secretas com nomes claros.

Ambiente habilitado x desabilitado

EstadoEfeito
DesabilitadoNão há uso válido das chaves contra o gateway até você habilitar de novo. As chaves permanecem armazenadas no sistema.
HabilitadoAs chaves passam a autenticar requisições conforme as regras de cada endpoint. Na primeira ativação, o Spark cria a chave pública e a primeira chave secreta e oferece um momento seguro para copiar.
Desligar o ambiente é útil em incidentes ou migrações: você corta o acesso programático imediato sem precisar revogar chave por chave.
Ao habilitar novamente, as chaves existentes continuam as mesmas; a interface pode lembrar que valores completos não são “reexpostos” como na primeira criação — use copiar na lista quando precisar do texto integral.

Chave pública e chaves secretas

TipoPrefixo típicoPapel
Chave públicapk_Identifica a organização em fluxos que a documentação da API marca como uso de chave pública.
Chave secretask_Autentica operações que exigem chave privada; é a credencial sensível — trate como senha.
Você pode ter várias chaves secretas, cada uma com um nome (ex.: “Produção”, “Staging”, “ERP”). Isso ajuda a saber qual sistema revogar quando alguém sai do projeto ou quando uma integração vaza.

Ativar ou desativar uma chave secreta

Na lista de chaves secretas existe controle de chave ativa na API. Desativar uma chave específica interrompe só os clientes que usam aquela credencial, sem desligar o ambiente inteiro nem as outras chaves.

Remover uma chave

É possível remover uma chave secreta da lista. Enquanto houver apenas uma chave secreta, a interface não permite excluí-la (evita deixar o ambiente sem credencial secreta útil). Para trocar a última chave de forma segura, crie uma nova, atualize as integrações e só então remova a antiga — ou use desativar temporariamente.
Remover ou desativar uma chave quebra qualquer sistema que ainda a use até você atualizar a credencial. O mesmo vale para desabilitar o ambiente inteiro.

Onde isso aparece no produto

  • Formulários de captação públicos (link ou iframe) carregam o fluxo com a chave na URL — o mesmo tipo de credencial gerenciada aqui; veja Formulários de captação.
  • Envio de modelos de mensagem para um chat (POST em chats/{chatId}/templates no gateway): veja abaixo.
  • Demais integrações server-to-server seguem o cabeçalho e o tipo de chave descritos na referência da API.

Enviar modelo com variáveis pela API

O endpoint de envio de template aceita o ID do modelo cadastrado no Spark. Variáveis funcionam como no painel:
  • Manuais — envie em commonVariables, com chaves var1, var2, … (cada número corresponde a {{1}}, {{2}} no texto do modelo).
  • Automáticas (dados do chat) — não envie no body; o Spark resolve com base no chatId da URL (nome, contato, aniversário ou campo personalizado configurado no modelo).
Exemplo mínimo:
{
  "templateId": "seu_template_id",
  "commonVariables": {
    "var1": "Promoção de maio",
    "var2": "15OFF"
  }
}
Se faltar valor para alguma variável manual obrigatória, a API responde com erro pedindo o preenchimento. Detalhes dos tipos de variável e configuração no modelo estão em Modelos de mensagem.

SDK oficial (TypeScript)

Para Node, Bun, Deno e runtimes compatíveis, use o pacote sparkcrm em vez de montar fetch manualmente. A documentação na aba SDKs cobre instalação, referência de métodos, tipos de webhook e tratamento de erros.

Referência técnica

Passo a passo de habilitação, cabeçalho X-API-Key, base URL e boas práticas de integração estão na Introdução à API (aba Referência da API).