REST API Overview

L'API REST de Profound CMS est fournie par le service Rust translation_manager. Elle expose des points de terminaison headless de lecture/flux utilisés par le moteur de rendu, ainsi que des points de terminaison d'écriture pour le contenu, la traduction et l'importation CSV.

Tous les exemples utilisent {CMS_API_URL} comme URL de base de votre hôte d'API CMS (par exemple https://cms.dev.tryprofound.com). Il n'y a aucun préfixe de chemin global — les routes sont montées à la racine, par ex. {CMS_API_URL}/routes.

Authentification

L'API utilise deux mécanismes distincts selon le point de terminaison.

Clé d'API (lectures headless + upsert de variante)

Envoyez la clé dans l'en-tête x-api-key ou le paramètre de requête api_key :

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

Les clés sont validées auprès de WorkOS et mises brièvement en cache en mémoire. Pour les points de terminaison de lecture, une clé d'API n'est requise que lorsque le serveur définit require_schema_api_key = true; autrement, les lectures anonymes sont autorisées. L'upsert de variante (PATCH /dataset/{schema_name}) exige toujours une clé valide portant la permission content_write.

Utilise l'authentification par clé d'API : /routes, /route, /blocks*, /components*, /dataset/*, /schemas/*, /content-changes.

JWT Bearer (WorkOS)

Les points de terminaison de gestion nécessitent un JWT utilisateur WorkOS :

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

Utilise l'authentification Bearer : /translation, /translations, /usage, /csv.

Résolution du site web (locataire)

Les points de terminaison utilisant une clé d'API déterminent le site web cible dans cet ordre :

1. Le paramètre de requête ?websiteId=<uuid>
2. L'en-tête Host, comparé à un domaine de site web configuré
3. La valeur de repli CMS_WEBSITE_ID (mono-locataire / développement local)

Si aucun ne se résout en UUID valide, le point de terminaison renvoie 400.

Modèle d'erreur

Vérification d'état

GET {CMS_API_URL}/health renvoie { "status": "ok" } et ne nécessite aucune authentification — utilisez-le pour les sondes de vivacité.