REST API Overview

Profound CMS REST API को Rust translation_manager सेवा द्वारा प्रदान किया जाता है। यह रेंडरर द्वारा उपयोग किए जाने वाले हेडलेस पढ़ने/स्ट्रीम एंडपॉइंट्स के साथ-साथ सामग्री, अनुवाद और CSV आयात के लिए लिखने वाले एंडपॉइंट्स को प्रदर्शित करती है।

सभी उदाहरण {CMS_API_URL} का उपयोग आपके CMS API होस्ट के आधार URL के रूप में करते हैं (उदाहरण के लिए https://cms.dev.tryprofound.com)। कोई वैश्विक पाथ उपसर्ग नहीं है — रूट्स को मूल पर माउंट किया जाता है, जैसे {CMS_API_URL}/routes।

प्रमाणीकरण

API एंडपॉइंट के आधार पर दो अलग-अलग योजनाओं का उपयोग करती है।

API कुंजी (हेडलेस रीड + वैरिएंट अपसर्ट)

कुंजी को x-api-key हेडर या api_key क्वेरी पैरामीटर के रूप में भेजें:

curl '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
  -H 'x-api-key: <आपकी-api-कुंजी>'

कुंजियों को WorkOS के विरुद्ध सत्यापित किया जाता है और थोड़े समय के लिए मेमोरी में कैश किया जाता है। रीड एंडपॉइंट्स के लिए, API कुंजी केवल तब आवश्यक होती है जब सर्वर require_schema_api_key = true सेट करता है; अन्यथा गुमनाम रीड की अनुमति है। वैरिएंट अपसर्ट (PATCH /dataset/{schema_name}) को हमेशा content_write अनुमति वाली एक वैध कुंजी की आवश्यकता होती है।

API-कुंजी प्रमाणीकरण उपयोग करता है: /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes।

बेयरर JWT (WorkOS)

प्रबंधन एंडपॉइंट्स को WorkOS उपयोगकर्ता JWT की आवश्यकता होती है:

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

बेयरर प्रमाणीकरण उपयोग करता है: /translation, /translations, /usage, /csv।

वेबसाइट (किरायेदार) का समाधान

API-कुंजी एंडपॉइंट्स लक्षित वेबसाइट को इस क्रम में निर्धारित करते हैं:

1. ?websiteId=<uuid> क्वेरी पैरामीटर
2. Host हेडर, जिसे एक विन्यस्त वेबसाइट डोमेन के विरुद्ध मिलाया जाता है
3. CMS_WEBSITE_ID फॉलबैक (एकल-किरायेदार / स्थानीय विकास)

यदि इनमें से कोई भी वैध UUID में समाधान नहीं करता है, तो एंडपॉइंट 400 लौटाता है।

त्रुटि मॉडल

स्वास्थ्य जांच

GET {CMS_API_URL}/health { "status": "ok" } लौटाता है और किसी प्रमाणीकरण की आवश्यकता नहीं होती — इसे जीवनता जांच के लिए उपयोग करें।