ZapyFlow/Documentación de la APIopenapi.json

API de ZapyFlow

Una API REST para todo lo que hace tu workspace — conversaciones, pedidos, citas, contactos, CRM, campañas y canales. 210 operaciones, 48 ámbitos, versión 2026-10-12.

Dirección base

text
https://api.zapyflow.com.br

El contrato legible por máquina está en /openapi.json (OpenAPI 3.1) y se genera desde el servidor en ejecución — no se escribe a mano.

Tu primera llamada

Crea una clave en el panel, en Desarrolladores → Claves de API. El secreto aparece una sola vez, al crearla. Concede solo los ámbitos que la integración necesita.

bash
curl https://api.zapyflow.com.br/api/conversations \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Qué es una clave — y qué no es

Una clave es un principal autenticado de un workspace, no una suplantación de quien la creó. Tres consecuencias que conviene conocer antes de construir:

ReglaQué significa para ti
La clave nunca supera a quien la creóEl permiso efectivo es la intersección de los ámbitos de la clave con las capacidades del rol de quien la creó. Si a esa persona la degradan, la clave se estrecha en la siguiente petición.
Las rutas de cuenta personal están cerradas a toda clavePerfil, contraseña, correo, sesiones y eliminación de cuenta no son alcanzables con una clave — incluidas las claves creadas antes de que existieran los ámbitos.
Una clave pertenece a un workspaceUna clave nunca lee ni escribe datos de otro workspace, sean cuales sean los ids que envíes.

Siguientes pasos

  • Autenticación — cabeceras, qué significa un 401, rotación de claves
  • Ámbitos — la lista completa, generada de la tabla de autorización del servidor
  • Webhooks — esquema de firma, reintentos y vectores de respuesta conocida