Ir para o conteúdo

Coleção do Postman#

Para testar e depurar solicitações à Green API, é recomendável usar a Coleção Green API - Postman.

Postman é uma ferramenta popular para testar e desenvolver APIs. Para facilitar a integração com a Green API, criamos uma coleção Postman com um conjunto completo de APIs necessárias.

  1. Instalação: instalar a Collection
  2. Configuração: configurar variáveis de ambiente
  3. Teste: usar métodos da API

Instalação#

Para começar, faça o download dos componentes listados abaixo e instale o Postman:

Após a instalação e a execução do Postman, clique em Import e selecione os dois arquivos JSON, collection.json e environment.json, do pacote da coleção Postman no GitHub.

Passo 1

Passo 2

Após a importação, você verá o item Green API na seção Collections e poderá selecionar Green API Developer como Environment.

Configuração#

O ambiente configurável do Postman é essencialmente um conjunto de pares "chave-valor". Você pode criar variáveis padrão que serão usadas em várias solicitações. Saiba mais sobre variáveis de ambiente no Postman.

O ambiente preconfigurado Green API Developer contém um conjunto completo de variáveis referenciadas na coleção. Algumas dessas variáveis devem ser editadas e substituídas pelos seus próprios valores. Para abrir a caixa de diálogo de edição, clique no pequeno botão com um ícone de olho ao lado da lista suspensa do ambiente e selecione Edit.

Defina os valores das variáveis idInstance e apiTokenInstance, que foram obtidos na etapa Antes de começar.

Teste#

Agora você pode selecionar qualquer método da API na coleção e começar a enviar solicitações. Todos os métodos estão listados na mesma ordem em que aparecem na Documentação da API para facilitar o teste e o processamento das respostas.