Panoramica dell'API

L'app web espone un'API HTTP sotto /api, utilizzata sia dall'app che dall'editor. Questa pagina ne descrive la struttura. Le route stesse si trovano nella directory api dell'app web.

Autenticazione

L'API è autenticata con una sessione. Accedi tramite gli endpoint di autenticazione, che impostano un cookie di sessione, e le richieste successive vengono autorizzate da quella sessione. È la stessa sessione utilizzata dall'app del browser.

Ambito

Le richieste sono limitate alla tua organizzazione e, dove applicabile, al tuo utente. Vedi e modifichi solo i tuoi dati.

Aree delle risorse

L'API è organizzata attorno alle risorse del prodotto, tra cui:

• Auth per accesso, registrazione e gestione delle sessioni.
• Design per progetti e le loro versioni.
• Asset per i media, inclusi upload con URL pre-firmati allo storage.
• Tag, brand e calendario per organizzare e revisionare il lavoro.
• Moduli per la configurazione e le sottomissioni dei moduli.

Upload

Gli upload dei media utilizzano URL pre-firmati, quindi i file vanno direttamente al tuo storage compatibile con S3 anziché passare attraverso l'app. Vedi Architettura.

Leggi le route

Per gli endpoint e i payload esatti, leggi i gestori delle route nell'app web. Sono la fonte di verità man mano che l'API evolve.