REST API Overview

Profound CMS REST API, Rust translation_manager servisi tarafından sunulur. Renderer tarafından kullanılan başsız okuma/akış uç noktalarını ve ayrıca içerik, çeviri ve CSV içe aktarma için yazma uç noktalarını sağlar.

Tüm örnekler, CMS API ana makinenizin temel URL'si olarak {CMS_API_URL} kullanır (örneğin https://cms.dev.tryprofound.com). Genel bir yol öneki yoktur — rotalar köke bağlanır, örn. {CMS_API_URL}/routes.

Kimlik doğrulama

API uç noktaları, uç noktaya bağlı olarak iki ayrı şema kullanır.

API anahtarı (başsız okumalar + varyant ekleme/güncelleme)

Anahtarı x-api-key başlığı veya api_key sorgu parametresi olarak gönderin:

curl '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
  -H 'x-api-key: <your-api-key>'

Anahtarlar WorkOS'a karşı doğrulanır ve kısa süreliğine bellekte önbelleğe alınır. Okuma uç noktaları için, sunucu require_schema_api_key = true olarak ayarladığında bir API anahtarı gerekir; aksi takdirde anonim okumalar mümkündür. Varyant ekleme/güncelleme (PATCH /dataset/{schema_name}) her zaman content_write iznini taşıyan geçerli bir anahtar gerektirir.

API anahtarı kimlik doğrulaması kullanır: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.

Taşıyıcı JWT (WorkOS)

Yönetim uç noktaları bir WorkOS kullanıcı JWT'si gerektirir:

curl '{CMS_API_URL}/usage?orgId=<uuid>' \
  -H 'Authorization: Bearer <workos-jwt>'

Taşıyıcı kimlik doğrulaması kullanır: /translation, /translations, /usage, /csv.

Web sitesini (kiracı) çözümleme

API anahtarı kullanan uç noktalar hedef web sitesini şu sırayla çözümler:

1. ?websiteId=<uuid> sorgu parametresi
2. Bir yapılandırılmış web sitesi alan adıyla eşleştirilen Host başlığı
3. CMS_WEBSITE_ID geri dönüşü (tek kiracılı / yerel geliştirme)

Hiçbiri geçerli bir UUID'ye çözümlenmezse uç nokta 400 döndürür.

Hata modeli

Sağlık denetimi

GET {CMS_API_URL}/health, { "status": "ok" } döndürür ve kimlik doğrulaması gerektirmez — canlılık yoklamaları için kullanın.