HOC SiteDokümantasyon

API

Web sitelerine, tasarım belgelerine, nesnelere, dosyalara, ayarlara ve içgörülere programatik erişim için /api/v1 altındaki sürümlü REST API.

API mevcut platform hesabınızı kullanır. Kayıt rotası sunmaz.

E-posta ve parolanızı giriş uç noktasına POST atın.

POST /api/v1/{locale}/auth/login
{
  "email": "string",
  "password": "string"
}
{
  "accessToken": "string"
}

Belirteci diğer tüm çağrılarda gönderin:

Authorization: Bearer <accessToken>

Hesap ayarlarınızdan aldığınız API anahtarı aynı başlıkta çalışır ve kendiliğinden süresi dolmaz.

Yüzeyin düzeni

  • Site kapsamlı kaynaklar /api/v1/{locale}/{websiteId}/... altındadır: sayfalar, chrome, bileşenler, nesneler, dosyalar, ayarlar, erişim, tema ve içgörüler.
  • Hesap kapsamlı kaynaklar site olmadan /api/v1/{locale}/... altındadır: siteler, şablonlar, belgeler, geri bildirim ve bildirimler.
  • Katalog kaynakları platformun kendisini anlatır: belge ucu, tasarım katalogları ve şu an okuduğunuz uç kataloğu.

Her ucun API uçları altında kimlik doğrulaması, istek ipuçları ve ucu çağıran MCP araçlarıyla bir sayfası vardır. Hata, sayfalama, filtre, deneme çalıştırma ve önbellek zamanlaması gibi ortak davranışlar Kurallar sayfasındadır.

İlgili