ZapyFlow/Documentación de la APIopenapi.json

Versionado

Esta referencia describe la versión 2026-10-12. No hay segmento de versión en la URL.

Por qué no existe /v1

Una versión en la ruta es la promesa de mantener dos servidores en pie. Preferimos prometer algo que sí podemos cumplir: solo cambios aditivos, más un camino de obsolescencia escrito para lo que tenga que desaparecer.

Qué puede cambiar sin aviso

  • Endpoints nuevos, campos opcionales nuevos en la petición, campos nuevos en la respuesta.
  • Valores nuevos en un enum que solo lees (nunca en uno que envías).
  • Tipos de evento nuevos en el catálogo y cabeceras nuevas en las entregas de webhook.
Escribe tu cliente de forma que los campos desconocidos en la respuesta se ignoren y los nombres de evento desconocidos se salten. Un cliente que rechaza una clave que no conoce se rompe con un cambio que no rompe a nadie más.

Qué cuenta como ruptura, y cómo te enteras

Eliminar un campo o un endpoint, renombrar cualquier cosa, endurecer la validación, o cambiar un código de estado. Esos llevan: aviso al correo del propietario del workspace, cabeceras Deprecation y Sunset en las respuestas afectadas, y al menos 90 días antes de que el cambio entre.

El número de versión es una fecha

2026-10-12 es el día en que este documento se generó desde el servidor. Responde la única pregunta que una fecha necesita responder — ¿esto es más nuevo que lo que leí la última vez? — y nadie tiene que acordarse de incrementar nada.