Usando con Postman

Postman es una herramienta para probar y explorar APIs REST de forma visual e intuitiva. Con la collection oficial de Evolution Go, puedes ejecutar solicitudes, configurar entornos y explorar todos los endpoints sin necesidad de escribir código.

Requisitos previos

Evolution Go instalado y en funcionamiento — consulta la guía de instalación
Postman instalado — descárgalo aquí
Tu API Key (GLOBAL_API_KEY configurada en tu .env)

Paso 1: Importar la Collection Oficial

La collection oficial de Evolution Go está disponible públicamente en Postman e incluye todos los endpoints de la API listos para usar.

Abrir Postman

Abre Postman en tu computadora o accede a Postman Web.

Acceder a Import

En la esquina superior izquierda, haz clic en Import.

Importar mediante enlace

Selecciona la pestaña Link y pega la URL de la collection oficial:

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

Confirmar importación

Haz clic en Continue y luego en Import. La collection Evolution Go aparecerá en tu barra lateral.

Paso 2: Crear el Environment

Las variables de entorno centralizan las configuraciones de tu instancia, permitiéndote cambiar entre entornos (local, staging, producción) sin modificar cada solicitud.

Crear nuevo Environment

En Postman, haz clic en Environments (ícono de ojo en la esquina superior derecha) y luego en + para crear uno nuevo.

Nombrar el Environment

Asígnale el nombre Evolution Go (o el nombre que prefieras).

Agregar las variables

Agrega las siguientes variables:

Variable	Valor inicial	Descripción
`base_url`	`http://localhost:8080`	URL base de tu servidor Evolution Go
`api_key`	`tu-clave-aquí`	Valor de `GLOBAL_API_KEY` en el `.env`
`instance_id`	(completar después de crear la instancia)	UUID de la instancia de WhatsApp

Guardar y activar

Haz clic en Save y selecciona el environment Evolution Go en el selector de la esquina superior derecha de Postman.

Nunca compartas ni expongas públicamente el valor de api_key. Proporciona acceso total a tu API.

Paso 3: Configurar los Headers de la Collection

Para no tener que agregar headers en cada solicitud individualmente, configúralos a nivel de la collection.

Abrir configuración de la collection

Haz clic derecho en Evolution Go en la barra lateral y selecciona Edit.

Acceder a la pestaña Variables

Confirma que las variables base_url, api_key e instance_id están referenciadas.

Configurar Pre-request Script (opcional)

Opcionalmente, agrega los headers predeterminados a todas las solicitudes mediante 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" });

Los headers requeridos para autenticación son:

apikey: tu GLOBAL_API_KEY
instanceId: UUID de la instancia (requerido en rutas que operan sobre una instancia específica)
Content-Type: application/json (para solicitudes con body)

Paso 4: Probar la Conexión

Antes de crear instancias, verifica que Evolution Go sea accesible. Solicitud:

GET {{base_url}}/

Una respuesta exitosa indica que el servidor está en funcionamiento. Si obtienes un error de conexión, verifica que Evolution Go esté corriendo y que base_url sea correcto.

Paso 5: Crear una Instancia de WhatsApp

Con la conexión verificada, crea tu primera instancia. Solicitud:

POST {{base_url}}/instance/create

Headers:

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

Body:

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

Respuesta exitosa:

{
  "instanceName": "mi-instancia",
  "instanceId": "249aad2e-68f9-464f-bc84-aca560c38f0e",
  "token": "tu-token-aquí",
  "status": "created"
}

Copia el instanceId de la respuesta y guárdalo en la variable instance_id de tu Environment para usarlo en las siguientes solicitudes.

Paso 6: Conectar a WhatsApp

Con la instancia creada, inicia la conexión con WhatsApp. Este endpoint también permite configurar el webhook para recibir eventos. Solicitud:

POST {{base_url}}/instance/connect

Headers:

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

Body:

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

Después de la solicitud, recibirás un QR Code via webhook (campo qrcode en base64). Escanéalo con tu WhatsApp móvil en Configuración > Dispositivos vinculados > Vincular dispositivo.

Para conectarte mediante Pairing Code en lugar de QR Code, agrega el campo phone al body con el número en el formato 5511999999999.

Explorando Más Endpoints

Accede a la documentación interactiva Swagger de tu instancia para descubrir todos los endpoints disponibles:

{{base_url}}/swagger/index.html

Swagger te permite visualizar parámetros, probar endpoints directamente en el navegador y ver ejemplos de respuesta.

Primeros Pasos

Configuración

Integraciones

Requisitos previos

Paso 1: Importar la Collection Oficial

Paso 2: Crear el Environment

Paso 3: Configurar los Headers de la Collection

Paso 4: Probar la Conexión

Paso 5: Crear una Instancia de WhatsApp

Paso 6: Conectar a WhatsApp

Explorando Más Endpoints

Próximos pasos

Configurar Webhooks

Configuración Inicial

​Requisitos previos

​Paso 1: Importar la Collection Oficial

​Paso 2: Crear el Environment

​Paso 3: Configurar los Headers de la Collection

​Paso 4: Probar la Conexión

​Paso 5: Crear una Instancia de WhatsApp

​Paso 6: Conectar a WhatsApp

​Explorando Más Endpoints

​Próximos pasos

Configurar Webhooks

Configuración Inicial

Requisitos previos

Paso 1: Importar la Collection Oficial

Paso 2: Crear el Environment

Paso 3: Configurar los Headers de la Collection

Paso 4: Probar la Conexión

Paso 5: Crear una Instancia de WhatsApp

Paso 6: Conectar a WhatsApp

Explorando Más Endpoints

Próximos pasos