Para desenvolvedores
OpenAPI e coleção Postman da API de WhatsApp
Os 153 endpoints da API em um arquivo OpenAPI 3.1 e em uma coleção Postman v2.1, nos três idiomas. Os arquivos são gerados da mesma fonte da referência em /docs/referencia e conferidos contra a especificação de produção.
153 endpoints em 17 categorias
Downloads
Especificação ao vivo
A especificação servida pela própria API (em português) fica em https://api.zapzapapi.com/openapi.json. Os arquivos desta página trazem os mesmos 153 endpoints, com textos em três idiomas.
Como importar
- Postman: Import, depois File (ou Link, colando a URL do arquivo). A coleção traz as variáveis baseUrl, apiKey, apiSecret e instanceId; preencha-as na aba Variables.
- Insomnia, Bruno e Hoppscotch: importe o arquivo OpenAPI ou a coleção Postman pelo menu de importação.
- Cliente tipado: gere um SDK com o OpenAPI Generator, por exemplo npx @openapitools/openapi-generator-cli generate -i zapzap-openapi.en.json -g typescript-fetch -o ./zapzap-client.
Autenticação
Toda requisição leva os cabeçalhos x-api-key e x-api-secret, que você copia no painel em Configurações e API. A base é https://api.zapzapapi.com/api/v1.
Exemplo: enviar um texto
curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/send/text" \
-H "x-api-key: SUA_CHAVE" \
-H "x-api-secret: SEU_SEGREDO" \
-H "Content-Type: application/json" \
-d '{"number":"5511999999999","text":"Hello!"}'Como estes arquivos são gerados
Um script (scripts/gerar-openapi.mjs) lê a referência da API do site e monta o OpenAPI e a coleção Postman. Ele falha se a contagem de operações divergir da fonte ou entre os idiomas, e mascara qualquer número de telefone que não seja claramente fictício.
Nenhum endpoint é escrito à mão: o que está na referência está nos arquivos, e só isso. Cada requisição da coleção usa os parâmetros obrigatórios da referência como exemplo.
Perguntas frequentes
A especificação é pública e gratuita?
Sim. Os arquivos são públicos e você pode baixar e importar a especificação do ZapZap API. Usar a API exige uma conta e as chaves x-api-key e x-api-secret.
Qual a diferença entre o OpenAPI daqui e o de api.zapzapapi.com?
Os dois descrevem os mesmos endpoints. O de api.zapzapapi.com está em português; os arquivos desta página existem também em inglês e espanhol, e a coleção Postman já vem pronta.
Preciso de conta para testar no Postman?
Para abrir e importar os arquivos, não. Para as chamadas funcionarem, você precisa das suas chaves e de uma instância, que se criam no painel.
Com que frequência os arquivos mudam?
Quando a referência da API muda, os arquivos são gerados de novo no mesmo deploy do site.
Pegue suas chaves e faça a primeira chamada
R$ 15 por número ativo por mês, sem cobrança por mensagem. Ao criar a conta e verificar o telefone, você recebe crédito de boas-vindas sem precisar depositar (um por telefone, sujeito à campanha vigente).