> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crmspark.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# SDKs do Spark

> Bibliotecas oficiais para integrar o Spark CRM à sua stack — tipagem, autenticação e acesso à API pública sem montar HTTP na mão.

Os SDKs do Spark encapsulam a [API pública](https://gateway.crmspark.com.br) 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.

<Tip title="Antes de codificar">
  Habilite o ambiente de desenvolvedores e obtenha uma chave em [Configurações → Desenvolvedores](https://crmspark.com.br/dash/settings/developers). O passo a passo está em [Modo Desenvolvedores](/conceitos/desenvolvedores) e na [Introdução à API](/api-reference/introduction).
</Tip>

## SDKs disponíveis

| Linguagem               | Pacote                                                      | Documentação                                          |
| ----------------------- | ----------------------------------------------------------- | ----------------------------------------------------- |
| TypeScript / JavaScript | [`sparkcrm` no npm](https://www.npmjs.com/package/sparkcrm) | [Começar com TypeScript](/sdks/typescript/introducao) |

Outras linguagens podem ser adicionadas no futuro. Enquanto isso, use a [Referência da API](/api-reference/introduction) (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.).
* **Chats** — criar ou atualizar uma conversa DM, ou enfileirar um lote em background.
* **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](/api-reference/webhooks); o SDK exporta os formatos de payload).
* **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](/api-reference/webhooks); 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 TypeScript | A stack ainda não tem SDK oficial           |
| Quer autocomplete e tipos no editor                | Precisa só de um curl ou de outra linguagem |
| Quer retentativas e erros tipados sem reinventar   | Já tem pipeline OpenAPI → cliente interno   |

## Próximos passos

* [TypeScript — instalação e primeiro uso](/sdks/typescript/introducao)
* [TypeScript — referência de recursos](/sdks/typescript/referencia)
* [Webhooks de saída](/api-reference/webhooks)