Resumen de la API

La aplicación web expone una API HTTP bajo /api, que usan tanto la aplicación como el editor. Esta página describe su estructura. Las rutas mismas residen en el directorio api de la aplicación web.

Autenticación

La API se autentica con una sesión. Inicias sesión a través de los endpoints de autenticación, que establecen una cookie de sesión, y las solicitudes posteriores se autorizan a partir de esa sesión. Esta es la misma sesión que usa la aplicación del navegador.

Ámbito

Las solicitudes se limitan a tu organización y, cuando corresponde, a tu usuario. Solo ves y modificas tus propios datos.

Áreas de recursos

La API está organizada en torno a los recursos del producto, incluyendo:

• Auth para inicio de sesión, registro y gestión de sesiones.
• Designs para proyectos y sus versiones.
• Assets para medios, incluyendo cargas presignadas al almacenamiento.
• Tags, brands y calendar para organizar y revisar el trabajo.
• Forms para la configuración de formularios y sus envíos.

Cargas

Las cargas de medios utilizan URLs presignadas, por lo que los archivos van directamente a tu almacenamiento compatible con S3, sin pasar por la aplicación. Consulta Arquitectura.

Lee las rutas

Para conocer los endpoints y payloads exactos, lee los manejadores de rutas en la aplicación web. Son la fuente de verdad a medida que la API evoluciona.