API-Übersicht

Die Web-App stellt eine HTTP-API unter /api bereit, die sowohl von der App als auch vom Editor genutzt wird. Diese Seite beschreibt ihre Struktur. Die Routen selbst befinden sich im Verzeichnis api der Web-App.

Authentifizierung

Die API wird mit einer Sitzung authentifiziert. Sie melden sich über die Authentifizierungsendpunkte an, die ein Sitzungscookie setzen, und nachfolgende Anfragen werden über diese Sitzung autorisiert. Dies ist dieselbe Sitzung, die auch die Browser-App verwendet.

Gültigkeitsbereich

Anfragen sind auf Ihre Organisation und, sofern zutreffend, auf Ihren Benutzer beschränkt. Sie sehen und ändern nur Ihre eigenen Daten.

Ressourcenbereiche

Die API ist um die Ressourcen des Produkts organisiert, darunter:

• Auth für Anmeldung, Registrierung und Sitzungsverwaltung.
• Designs für Projekte und deren Versionen.
• Assets für Medien, einschließlich vorab signierter Uploads in den Speicher.
• Tags, Marken und Kalender zur Organisation und Überprüfung der Arbeit.
• Formulare für Formularkonfiguration und -übermittlungen.

Uploads

Medien-Uploads verwenden vorab signierte URLs, sodass Dateien direkt in Ihren S3-kompatiblen Speicher gelangen, anstatt über die App zu gehen. Siehe Architektur.

Lesen Sie die Routen

Für genaue Endpunkte und Payloads lesen Sie die Routen-Handler in der Web-App. Sie sind die maßgebliche Quelle, während sich die API weiterentwickelt.