Skip to main content
Os SDKs do Spark encapsulam a API pública em clientes prontos para o seu ambiente de execução: autenticação com chave de API, tipos TypeScript, tratamento de erros, retentativas e métodos nomeados para cada recurso.
Habilite o ambiente de desenvolvedores e obtenha uma chave em Configurações → Desenvolvedores. O passo a passo está em Modo Desenvolvedores e na Introdução à API.

​
SDKs disponíveis

LinguagemPacoteDocumentação
TypeScript / JavaScriptsparkcrm no npmComeçar com TypeScript
Outras linguagens podem ser adicionadas no futuro. Enquanto isso, use a Referência da API (OpenAPI) com o gerador de cliente da sua preferência.

​
O que os SDKs cobrem hoje

  • Entrypoints — listar e consultar canais conectados (WhatsApp, Instagram, etc.).
  • Formulários — ler definição pública, política de iframe e enviar submissões pela API.
  • Mensageria — listar mensagens, enviar texto/mídia, upload de arquivos e envio de modelos com variáveis.
  • Tipos de webhook — estruturas para chats.created, messages.received e messages.sent (a entrega em si usa Svix; o SDK exporta os formatos de payload).

​
Escolher SDK ou HTTP direto

Prefira o SDK quando…Prefira HTTP/OpenAPI quando…
Você usa Node, Bun, Deno ou Workers com TypeScriptA stack ainda não tem SDK oficial
Quer autocomplete e tipos no editorPrecisa só de um curl ou de outra linguagem
Quer retentativas e erros tipados sem reinventarJá tem pipeline OpenAPI → cliente interno

​
Próximos passos