Bem-vindo à documentação da Spaik API.
A Spaik API é uma interface REST que permite gerenciar dispositivos conectados ao WhatsApp e realizar o envio programático de mensagens. Ela foi projetada para oferecer uma camada simples, segura e escalável para integração de sistemas com operações de mensageria via WhatsApp.
Esta documentação apresenta uma visão geral das funcionalidades disponíveis. Os detalhes técnicos de cada endpoint — incluindo parâmetros, payloads, respostas e códigos de status — estão descritos automaticamente na especificação OpenAPI desta API.
Entre em contato com nosso suporte para obter sua API KEY e Token de utilização pelo Whatsapp: +55 48 98865-2752
🔐 Autenticação
A autenticação é obrigatória para todos os endpoints da Spaik API.
Para realizar qualquer requisição, o integrador deve enviar sua API Key no header da chamada HTTP, utilizando o campo:
x-api-key: SUA_API_KEY📦 O que você pode fazer com a API
A API está organizada em dois grandes grupos de funcionalidades:
🔹 Devices
Permite gerenciar instâncias (devices) conectadas ao WhatsApp, incluindo:
- Criação de novos devices
- Atualização de configurações
- Listagem de devices
- Consulta de informações da instância
- Geração de QR Code para autenticação
- Logout/desconexão de devices
Esses recursos permitem controlar completamente o ciclo de vida das conexões WhatsApp utilizadas pela sua aplicação.
🔹 WhatsApp
Permite o envio de mensagens através de um device previamente conectado.
É possível:
- Enviar mensagens de texto
- Enviar arquivos em Base64 (incluindo stickers)
- Controlar identificadores de mensagem
- Associar envios a lotes e empresas
⚠️ Uso Responsável e Limites do WhatsApp
A Spaik API não deve ser utilizada para spam, disparos em massa não autorizados ou operações excessivas.
O WhatsApp possui políticas rígidas contra:
- Envio de mensagens não solicitadas
- Alto volume de mensagens em curto período
- Comportamentos automatizados suspeitos
- Bloqueios e denúncias frequentes por parte de destinatários
O uso inadequado pode resultar em:
- Bloqueio temporário ou permanente do número
- Banimento da conta WhatsApp
- Perda da sessão do device
- Restrição definitiva do número na plataforma
É de total responsabilidade do integrador garantir que:
- Haja consentimento do destinatário
- Os envios respeitem limites naturais de uso humano
- Não sejam realizadas tentativas de burlar restrições da plataforma
Recomendamos fortemente que a API seja utilizada para comunicações legítimas, como atendimento, notificações autorizadas e interações previamente consentidas.
📄 Documentação Técnica
Os detalhes completos de cada endpoint — incluindo schemas, exemplos de request/response e códigos HTTP — estão disponíveis na especificação OpenAPI integrada a esta documentação.
Se utilizada corretamente, a Spaik API fornece uma maneira eficiente e confiável de integrar sistemas ao WhatsApp, mantendo controle sobre dispositivos e fluxos de envio de mensagens.
🧪 Ambiente de Testes
Para testes e homologação, utilize o ambiente de staging da Spaik API:
https://stg.wapi.spaik.com.br/api/