Skip to main content
Em Configurações → Desenvolvedores, um administrador liga o acesso à API da organização e gerencia as credenciais usadas por integrações, formulários públicos, ERPs e scripts. Nada muda na rotina do time de atendimento: é um interruptor de acesso e um cofre de chaves.

​
Para que serve

  • Permitir que sistemas externos leiam e enviem dados pelo gateway público em nome da organização, e não de uma pessoa.
  • Pausar todas as integrações de uma vez, desligando o acesso, sem apagar as chaves.
  • Separar credenciais por sistema (produção, homologação, parceiro) com várias chaves secretas nomeadas.
  • Receber eventos do Spark no seu sistema por webhooks.

​
Ligar e desligar o acesso

Desligar é útil em incidentes ou migrações: corta todo acesso pela API na hora. Ao religar, as chaves continuam as mesmas.

​
Chaves

Você pode criar várias chaves secretas, cada uma com um nome (“ERP”, “Site”, “Parceiro X”). Assim, fica fácil saber qual desativar se um sistema sair do ar ou uma chave vazar.
  • Desativar uma chave secreta interrompe só os sistemas que usam essa chave.
  • Remover uma chave apaga a credencial. Enquanto houver uma única chave secreta, ela não pode ser removida: crie a nova, atualize as integrações e só então remova a antiga.
Desativar, remover uma chave ou desligar o acesso quebra qualquer sistema que dependa dela até a credencial ser atualizada.

​
Webhooks

Na aba “Webhooks” da mesma página, você cadastra os endereços do seu sistema que devem receber eventos como mensagens recebidas e enviadas, conversas criadas e mudanças em modelos. Veja os eventos, o formato e como validar a assinatura em Webhooks.

​
O que dá para fazer pela API

​
Enviar um modelo com variáveis

Para enviar um modelo a uma conversa (POST /v1/messaging/chats/{chatId}/templates), informe o ID do modelo e os valores das variáveis manuais em commonVariables, onde var1 corresponde a {{1}}, var2 a {{2}} e assim por diante. Variáveis automáticas são preenchidas pelo Spark com os dados da conversa e não devem ser enviadas.
Se faltar o valor de alguma variável manual, a API responde com erro indicando o que preencher. O ponto de partida é a Introdução à API. Para Node.js, Bun e Deno, o SDK oficial sparkcrm simplifica a integração: veja SDKs.