Usando com Postman

O Postman é uma ferramenta para testar e explorar APIs REST de forma visual e intuitiva. Com a collection oficial do Evolution Go, você pode executar requisições, configurar ambientes e explorar todos os endpoints sem precisar escrever código.

Pré-requisitos

Evolution Go instalado e rodando — veja o guia de instalação
Postman instalado — baixe aqui
Sua API Key (GLOBAL_API_KEY configurada no .env)

Passo 1: Importar a Collection Oficial

A collection oficial do Evolution Go está disponível publicamente no Postman e contém todos os endpoints da API prontos para uso.

Abrir o Postman

Abra o Postman no seu computador ou acesse o Postman Web.

Acessar Import

No canto superior esquerdo, clique em Import.

Importar via link

Selecione a aba Link e cole a URL da collection oficial:

https://www.postman.com/agenciadgcode/evolution-api/collection/u95jxho/evolution-go

Confirmar importação

Clique em Continue e depois em Import. A collection Evolution Go aparecerá na sua barra lateral.

Passo 2: Criar o Environment

As variáveis de ambiente centralizam as configurações da sua instância, permitindo trocar entre ambientes (local, staging, produção) sem alterar cada requisição.

Criar novo Environment

No Postman, clique em Environments (ícone de olho no canto superior direito) e depois em + para criar um novo.

Nomear o Environment

Dê o nome Evolution Go (ou outro nome de sua preferência).

Adicionar as variáveis

Adicione as seguintes variáveis:

Variável	Valor inicial	Descrição
`base_url`	`http://localhost:8080`	URL base do seu servidor Evolution Go
`api_key`	`sua-chave-aqui`	Valor do `GLOBAL_API_KEY` no `.env`
`instance_id`	(preencher após criar instância)	UUID da instância WhatsApp

Salvar e ativar

Clique em Save e selecione o environment Evolution Go no seletor no canto superior direito do Postman.

Nunca compartilhe ou exponha o valor da api_key publicamente. Ela dá acesso total à sua API.

Passo 3: Configurar os Headers da Collection

Para não precisar adicionar os headers em cada requisição individualmente, configure-os no nível da collection.

Abrir configurações da collection

Clique com o botão direito em Evolution Go na sidebar e selecione Edit.

Acessar a aba Variables

Confirme que as variáveis base_url, api_key e instance_id estão referenciadas.

Configurar Pre-request Script (opcional)

Se preferir, adicione os headers padrão em todas as requisições via Pre-request Script:

pm.request.headers.add({ key: "apikey", value: pm.environment.get("api_key") });
pm.request.headers.add({ key: "instanceId", value: pm.environment.get("instance_id") });
pm.request.headers.add({ key: "Content-Type", value: "application/json" });

Os headers necessários para autenticação são:

apikey: sua GLOBAL_API_KEY
instanceId: UUID da instância (necessário nas rotas que operam sobre uma instância específica)
Content-Type: application/json (para requisições com body)

Passo 4: Testar a Conexão

Antes de criar instâncias, verifique se o Evolution Go está acessível. Requisição:

GET {{base_url}}/

Uma resposta de sucesso indica que o servidor está no ar. Se retornar erro de conexão, verifique se o Evolution Go está rodando e se o base_url está correto.

Passo 5: Criar uma Instância WhatsApp

Com a conexão verificada, crie sua primeira instância. Requisição:

POST {{base_url}}/instance/create

Headers:

Key	Value
`Content-Type`	`application/json`
`apikey`	`{{api_key}}`

Body:

{
  "instanceName": "minha-instancia",
  "integration": "WHATSAPP-BAILEYS"
}

Resposta de sucesso:

{
  "instanceName": "minha-instancia",
  "instanceId": "249aad2e-68f9-464f-bc84-aca560c38f0e",
  "token": "seu-token-aqui",
  "status": "created"
}

Copie o instanceId da resposta e salve na variável instance_id do seu Environment para usar nas próximas requisições.

Passo 6: Conectar ao WhatsApp

Com a instância criada, inicie a conexão com o WhatsApp. Este endpoint também permite configurar o webhook para receber eventos. Requisição:

POST {{base_url}}/instance/connect

Headers:

Key	Value
`Content-Type`	`application/json`
`apikey`	`{{api_key}}`
`instanceId`	`{{instance_id}}`

Body:

{
  "webhookUrl": "https://webhook.site/seu-id-unico",
  "subscribe": ["ALL"],
  "immediate": true
}

Após a requisição, você receberá um QR Code via webhook (campo qrcode em base64). Escaneie-o com o WhatsApp do seu celular em Configurações > Dispositivos conectados > Conectar dispositivo.

Para conectar via Pairing Code ao invés de QR Code, adicione o campo phone no body com o número no formato 5511999999999.

Explorando Mais Endpoints

Acesse a documentação interativa Swagger da sua instância para descobrir todos os endpoints disponíveis:

{{base_url}}/swagger/index.html

O Swagger permite visualizar parâmetros, testar endpoints diretamente no navegador e ver exemplos de response.

Primeiros Passos

Configuração

Integrações

Pré-requisitos

Passo 1: Importar a Collection Oficial

Passo 2: Criar o Environment

Passo 3: Configurar os Headers da Collection

Passo 4: Testar a Conexão

Passo 5: Criar uma Instância WhatsApp

Passo 6: Conectar ao WhatsApp

Explorando Mais Endpoints

Próximos passos

Configurar Webhooks

Configuração Inicial

​Pré-requisitos

​Passo 1: Importar a Collection Oficial

​Passo 2: Criar o Environment

​Passo 3: Configurar os Headers da Collection

​Passo 4: Testar a Conexão

​Passo 5: Criar uma Instância WhatsApp

​Passo 6: Conectar ao WhatsApp

​Explorando Mais Endpoints

​Próximos passos

Configurar Webhooks

Configuração Inicial

Pré-requisitos

Passo 1: Importar a Collection Oficial

Passo 2: Criar o Environment

Passo 3: Configurar os Headers da Collection

Passo 4: Testar a Conexão

Passo 5: Criar uma Instância WhatsApp

Passo 6: Conectar ao WhatsApp

Explorando Mais Endpoints

Próximos passos