Empresa brasileira · Entrega automática · Suporte em português Seg a sex, 9h as 18h · PIX em reais
ProxyBox
API de WhatsApp · Integrações

Especificação OpenAPI, coleção do Postman e página de status da API de WhatsApp

Onde ficam o OpenAPI 3.1, a coleção do Postman e a página de status da API de WhatsApp, como importar no Postman, Insomnia e Bruno e como ler o status.

4 min de leitura Atualizado em 14 de novembro de 2026

Recurso em beta: pode mudar. Os três endereços abaixo são gerados do mesmo catálogo de operações da API e só abrem quando a página API de WhatsApp abre ao público. Antes disso, respondem 404.

Resposta curta: a especificação OpenAPI 3.1 fica em https://proxybox.com.br/api-whatsapp/openapi.json, a coleção do Postman em https://proxybox.com.br/api-whatsapp/postman.json e o estado do serviço em https://proxybox.com.br/api-whatsapp/status. Importe o primeiro ou o segundo no seu cliente de API, preencha apikey com a chave da instância e teste.

O que é cada arquivo?

Endereço O que é Para que serve
/api-whatsapp/openapi.json Especificação OpenAPI 3.1, em português, com exemplos por rota e o esquema do cabeçalho apikey Gerar cliente de código, importar em Insomnia e Bruno, validar chamadas
/api-whatsapp/postman.json Coleção do Postman v2.1, com a variável {{apikey}} Testar as rotas à mão
/api-whatsapp/status Página de estado do serviço e histórico de incidentes; ?format=json devolve o mesmo em JSON Saber se o problema é seu ou nosso

Os arquivos são gerados do mesmo catálogo que alimenta o painel, o conector MCP e esta documentação. Quando uma rota muda, os três mudam juntos. Eles ficam fora do caminho /api/ de propósito, para os robôs de busca e de IA poderem lê-los.

Como importo no Postman?

  1. No Postman, clique em Import.
  2. Cole https://proxybox.com.br/api-whatsapp/postman.json e confirme.
  3. Abra a coleção, vá em Variables e preencha apikey com a chave da instância (pbwa_…).
  4. Abra GET /instance e clique em Send. Uma resposta com "ok": true e o estado da instância mostra que a chave funciona.

Como importo no Insomnia?

  1. Em Create, escolha Import e From URL.
  2. Cole https://proxybox.com.br/api-whatsapp/openapi.json.
  3. Nas variáveis de ambiente, crie apikey com a sua chave, ou acrescente o cabeçalho apikey na coleção.

Quer rodar isto agora? O sandbox é grátis, não precisa de número e já vem com a chave da API.

Testar grátis

Como importo no Bruno?

  1. Em Collections, escolha Import collection e o tipo OpenAPI.
  2. Informe o endereço do openapi.json (ou baixe o arquivo antes e escolha-o do disco).
  3. Nas variáveis do ambiente, crie apikey.

Os nomes dos menus mudam entre versões desses programas; o caminho é sempre importar por endereço ou por arquivo.

Como uso a especificação para gerar código?

Qualquer gerador de OpenAPI aceita o arquivo. Um exemplo com o gerador de linha de comando mais comum:

bash
curl -o whatsapp-openapi.json https://proxybox.com.br/api-whatsapp/openapi.json
npx @openapitools/openapi-generator-cli generate -i whatsapp-openapi.json -g python -o ./cliente-whatsapp

O código gerado herda os campos to, media e schedule de cada rota. Para um uso simples, as chamadas diretas dos primeiros passos costumam ser menores.

Como leio a página de status?

A página de status mostra:

  • O estado atual do serviço, tirado das verificações do próprio sistema: se está funcionando, com problema ou fora do ar.
  • A porcentagem de instâncias respondendo, somando todas, sem dado de nenhum cliente.
  • O histórico de incidentes, escrito pela equipe: o que aconteceu, quando começou e quando acabou.
bash
curl "https://proxybox.com.br/api-whatsapp/status?format=json"

O que ela não mostra: o estado de um número seu (isso é GET /instance e GET /health) e se o WhatsApp está fora do ar no mundo todo. Um número desconectado quase sempre é assunto do número, não do serviço. A ordem para investigar é: GET /health, o histórico de erros e limites e, se tudo estiver bem do seu lado, a página de status.

E o llms.txt?

A ProxyBox publica um llms.txt com o resumo da API para assistentes de IA e agentes de código, apontando para estes arquivos e para os guias. Ele não substitui o OpenAPI: serve para quem lê em Markdown. O conector MCP é o caminho para quem trabalha dentro do Claude ou do Cursor.

E a mudança de versão?

A versão da API está no caminho (/v1). Mudanças que quebram código existente serão anunciadas no histórico de versões com data antes de entrar. A especificação sempre descreve a versão atual, e cada rota nova aparece como beta até ser provada em uso real.

Índice completo: documentação. Sobre o produto: uma instância de WhatsApp por número.

Autoria: equipe técnica da ProxyBox. Atualizado em 14/11/2026; endereços conferidos no ar nesta data.

Guias relacionados

Pronto para colocar no ar?

Comece no sandbox, grátis. Quando funcionar, contrate a instância do seu número e pague com PIX ou saldo.

Com IP brasileiro dedicado R$ 89,90/mês
Só a instância (traga o seu IP) R$ 39,90/mês
Travou em alguma etapa?Manda o print do erro no WhatsApp. Respondemos em português.
Suporte em português Fale no WhatsApp