Skip to main content
O cliente oficial sparkcrm dá acesso tipado à API do Spark a partir de TypeScript ou JavaScript no servidor. O código-fonte e o changelog ficam no repositório gepetojj/spark-typescript.

Requisitos

Instalação

Configurar o cliente

Crie o cliente uma vez por processo e reutilize. Em ambientes serverless, crie um por requisição.
Se você não passar apiKey, o cliente lê SPARK_API_KEY do ambiente.
Use a chave sk_… só no servidor. Não coloque a chave em apps mobile, front-end público ou repositórios.

Primeira chamada

Liste os canais (entrypoints) da organização:
Para filtrar por plataforma:

Tipos exportados

Parâmetros e respostas de cada método são tipados. Use o namespace SparkCRM para anotar variáveis:
No editor, passe o mouse sobre um método, como client.entrypoints.list, para ver a descrição de cada campo.

Fluxos comuns

Criar ou atualizar um chat

Para muitos contatos no mesmo canal, enfileire um lote. A resposta informa só quantos itens foram aceitos; o processamento acontece depois e não devolve IDs.

Enviar mensagem de texto

Enviar mídia

Faça o upload do arquivo e use o id devolvido no envio:

Enviar modelo com variáveis

Envie as variáveis manuais em commonVariables (var1, var2, …). As variáveis automáticas, como o nome do chat, são preenchidas pelo Spark. Veja Modelos de mensagem.

Enviar resposta a um formulário

Webhooks

O SDK não recebe nem envia webhooks. Ele exporta os tipos dos eventos (SparkCRM.MessagesReceivedWebhook e outros) para você tipar o handler depois de verificar a assinatura. Veja TypeScript: webhooks e tipos.

Próximos passos