API & Desenvolvedores
7 min de leituraAtualizado em 02 ago. de 2026

Postman e OpenAPI

Baixe a coleção oficial e consulte a referência pública sincronizada com o aplicativo.

A CloudWhats mantém uma única coleção Postman gerada a partir da mesma especificação OpenAPI exibida na documentação pública. Rotas, métodos e permissões ficam sincronizados com o código do aplicativo.

Fontes oficiais

Referência navegável

Pesquise por módulo, rota ou permissão e consulte parâmetros, corpos, respostas e exemplos de código.

Coleção Postman

Baixe todos os endpoints públicos em um único arquivo com autenticação, variáveis e exemplos organizados por módulo.

Como importar no Postman

1

Crie uma chave de integração

Conceda apenas os escopos necessários

No painel, acesse Configurações > Chaves de integração. Separe chaves de produção e testes e aplique o princípio do menor privilégio.

2

Baixe e importe a coleção

Use o arquivo oficial gerado pelo aplicativo

Baixe a coleção acima e, no Postman, selecione Import para carregar o arquivo JSON. Todas as operações ficam agrupadas pelos mesmos módulos da documentação pública.

3

Configure as variáveis

Defina baseUrl e apiKey na coleção

Use https://cloudwhats.app.br em baseUrl e informe sua chave wcp_... em apiKey. Os identificadores dinâmicos podem ser definidos conforme os recursos da sua conta.

4

Execute e confirme as permissões

Valide primeiro uma operação de leitura

Comece por uma listagem do módulo autorizado. Respostas 401 indicam chave ausente ou inválida; respostas 403 indicam falta do escopo informado na própria operação.

Autenticação e segurança

Bearer token

Authorization: Bearer wcp_sua_chave_aqui

Escopos por operação

Cada endpoint informa o escopo exato, como contacts:read, messages:send ou reports:read.

Nunca compartilhe uma chave real

Não envie chaves em tickets, prints ou arquivos versionados. Revogue imediatamente qualquer chave que tenha sido exposta.

A documentação acompanha o código

Ao alterar um handler ou uma permissão, a checagem de documentação detecta se os artefatos OpenAPI e Postman precisam ser regenerados.

Próximos passos

Este artigo resolveu sua dúvida?

Sua avaliação ajuda a priorizar revisões de conteúdo.