API'ye genel bakış

Web uygulaması, hem uygulamanın hem de editörün kullandığı bir HTTP API'sini /api altında sunar. Bu sayfa onun yapısını anlatır. Rotaların kendisi web uygulamasının api dizininde bulunur.

Kimlik doğrulama

API bir oturumla kimlik doğrulaması yapar. Kimlik doğrulama uç noktaları üzerinden oturum açarsınız, bunlar bir oturum çerezi ayarlar ve sonraki istekler o oturumdan yetkilendirilir. Bu, tarayıcı uygulamasının kullandığı oturumun aynısıdır.

Kapsam

İstekler organizasyonunuzla, geçerli olduğu durumlarda kullanıcınızla sınırlıdır. Yalnızca kendi verilerinizi görür ve değiştirirsiniz.

Kaynak alanları

API, ürünün kaynaklarına göre düzenlenmiştir; şunlar dahil:

• Oturum açma, kaydolma ve oturum yönetimi için Auth.
• Projeler ve sürümleri için Designs.
• Depolamaya önceden imzalanmış yüklemeler dahil, medya için Assets.
• İşi düzenlemek ve gözden geçirmek için Tags, brands ve calendar.
• Form yapılandırması ve gönderimleri için Forms.

Yüklemeler

Medya yüklemeleri önceden imzalanmış URL'ler kullanır, böylece dosyalar uygulama üzerinden değil doğrudan S3 uyumlu depolamanıza gider. Bkz. Mimari.

Rotaları okuyun

Kesin uç noktalar ve veri yükleri için web uygulamasındaki rota işleyicilerini okuyun. API geliştikçe doğruluğun kaynağı onlardır.