Aperçu de l’API

L’application web expose une API HTTP sous /api, utilisée à la fois par l’application et par l’éditeur. Cette page en décrit la structure. Les routes elles‑mêmes se trouvent dans le répertoire api de l’application web.

Authentification

L’API est authentifiée via une session. Vous vous connectez par les points de terminaison d’authentification, qui définissent un cookie de session, et les requêtes suivantes sont autorisées à partir de cette session. Il s’agit de la même session que celle utilisée par l’application navigateur.

Portée

Les requêtes sont limitées à votre organisation et, le cas échéant, à votre utilisateur. Vous ne voyez et ne modifiez que vos propres données.

Domaines de ressources

L’API est organisée autour des ressources du produit, notamment :

• Auth pour la connexion, l’inscription et la gestion des sessions.
• Designs pour les projets et leurs versions.
• Assets pour les médias, y compris les téléversements présignés vers le stockage.
• Étiquettes, marques et calendrier pour organiser et réviser le travail.
• Formulaires pour la configuration des formulaires et les soumissions.

Téléversements

Les téléversements de médias utilisent des URL présignées, de sorte que les fichiers sont envoyés directement vers votre stockage compatible S3, sans passer par l’application. Voir Architecture.

Consultez les routes

Pour les points de terminaison exacts et les charges utiles, lisez les gestionnaires de route dans l’application web. Ils sont la source de vérité à mesure que l’API évolue.