Colección de Postman

Una colección con todas las rutas de esta referencia, organizadas en las mismas secciones, con cuerpos de ejemplo listos para enviar y los ids pasando de una llamada a la siguiente sin copiar nada.

Descargar la colecciónDescargar el entorno

La colección está en portugués

Los nombres de carpetas y solicitudes y las descripciones están, por ahora, en portugués de Brasil. Rutas, cuerpos y variables son los mismos en cualquier idioma — la descripción en español de cada ruta está en la referencia de la API.

Importar

1. En Postman, Import → arrastra los dos archivos. Si prefieres no descargarlos, Import → Link y pega https://docs.joinotify.com/postman/Joinotify.postman_collection.json.
2. Selecciona el entorno Joinotify — Produção en la esquina superior derecha.
3. Completa apiKey con tu token sk_live_... — se genera en el panel después de conectar un número. La variable es de tipo secret: Postman la oculta en pantalla.
4. Ejecuta primero Conta → Listar números de origem (GET /account/senders). Guarda el phoneNumberId y el wabaId de tu primer número, que el espejo /v1 y varias rutas usan.

La autenticación es de toda la colección (Bearer Token con {{apiKey}}). Las pocas rutas públicas — planes, intercambio del código de emparejamiento, webhook de disparo de flujo — ya vienen con No Auth.

Insomnia

Insomnia importa colecciones de Postman: Create → Import → elige el archivo de la colección.

Variables

Variable	De dónde viene
baseUrl	El entorno. https://api.joinotify.com
apiKey	El entorno. Tu token sk_live_...
phoneNumberId	GET /account/senders, la primera vez que se ejecuta
wabaId	GET /account/senders, la primera vez que se ejecuta
businessId	Lo completas tú — solo lo usan las rutas de bases de clientes del espejo
contactId, broadcastId, audienceId, tagId…	Se guardan solos, ver abajo
mediaContentType	El Content-Type de las subidas en bytes crudos. Viene image/jpeg; cámbialo al de tu archivo

Ids que se completan solos

Crear un recurso guarda su id: Criar contato (crear contacto) completa contactId, y a continuación Consultar um contato, Editar um contato y Registrar opt-in ya apuntan a él. Lo mismo vale para campañas, públicos, etiquetas, campos, endpoints de webhook y claves.

Un listado también guarda el id del primer elemento — pero solo mientras la variable sigue vacía, para no cambiar el recurso con el que estás trabajando. Para apuntar a otro, edita el valor en Variables de la colección.

Deja los ids fuera del entorno

Los ids viven en las variables de la colección. Postman lee el entorno antes que ellas, así que una variable con el mismo nombre en el entorno — aunque esté vacía — oculta el id que se acaba de guardar.

Qué viene listo

• Enviar mensaje aparece en cuatro variantes: texto, plantilla, plantilla programada y mensaje de prueba.
• Responder en una conversación de la bandeja viene como texto, plantilla y nota interna.
• POST /messages, POST /contacts/sync y POST /site-events traen el header Idempotency-Key desactivado y completado con {{$guid}} — actívalo para que un reintento devuelva la primera respuesta en lugar de ejecutarse de nuevo.
• Los parámetros de consulta opcionales (filtros, limit, offset) vienen listados y desactivados, cada uno con la descripción de la referencia.

Los cuerpos de ejemplo usan números y nombres ficticios, y los de plantilla suponen una plantilla aprobada con ese nombre — cámbialos por los tuyos antes de enviar.

Mantenerla al día

La colección sigue la versión de la referencia, indicada al final de su descripción. Cuando la API gane rutas, descárgala de nuevo e impórtala: Postman reconoce la colección y ofrece reemplazar la que ya tienes. Tus variables de entorno no se tocan.

¿Prefieres generar la tuya a partir de la spec? El archivo OpenAPI también se importa en Postman.