Aller au contenu

L’API REST

L’API REST de StudioCMS est un outil puissant qui vous permet d’interagir avec votre contenu StudioCMS par programmation. Elle offre un moyen simple et flexible de gérer et de diffuser votre contenu via Astro DB.

L’API REST de StudioCMS est optimisée par les points de terminaison d’Astro et offre une interface RESTful pour interagir avec votre contenu StudioCMS. Vous trouverez ci-dessous une description de l’API REST de StudioCMS et de ses composants.

Pour accéder aux points de terminaison protégés de l’API REST de StudioCMS, vous devez fournir un jeton d’API dans l’en-tête Authorization de vos requêtes. Vous pouvez générer un jeton d’API en vous connectant au tableau de bord de StudioCMS et en accédant à la section « Jetons d’API » du profil utilisateur.

L’API REST de StudioCMS fournit plusieurs points de terminaison permettant d’interagir avec votre contenu StudioCMS. Ces points de terminaison sont principalement utilisés en interne par StudioCMS, mais les développeurs peuvent également y accéder pour interagir avec les données de StudioCMS. Voici les points de terminaison fournis par l’API REST de StudioCMS :

Ces points de terminaison sont accessibles au public et ne nécessitent aucune authentification. Ils offrent un accès en lecture seule à l’arborescence de contenu de StudioCMS. Par conséquent, ils ne prennent en charge que les requêtes GET.

  • /studiocms_api/rest/v1/public/folders/ : Fournit une liste de tous les dossiers publics dans l’arborescence de contenu de StudioCMS.
  • /studiocms_api/rest/v1/public/folders/[id] : Fournit des détails sur un dossier public spécifique dans l’arborescence de contenu de StudioCMS.
  • /studiocms_api/rest/v1/public/pages/ : Fournit une liste de toutes les pages publiques dans l’arborescence de contenu de StudioCMS.
  • /studiocms_api/rest/v1/public/pages/[id] : Fournit des détails sur une page publique spécifique dans l’arborescence de contenu de StudioCMS.
  • /studiocms_api/rest/v1/folders/ : Fournit une liste de tous les dossiers dans l’arborescence de contenu de StudioCMS.
  • /studiocms_api/rest/v1/folders/[id] : Fournit des détails sur un dossier spécifique dans l’arborescence de contenu de StudioCMS.
  • /studiocms_api/rest/v1/pages/ : Fournit une liste de toutes les pages de l’arborescence de contenu de StudioCMS.
  • /studiocms_api/rest/v1/pages/[id] : Fournit des détails sur une page spécifique dans l’arborescence de contenu de StudioCMS.
  • /studiocms_api/rest/v1/pages/[id]/history/ : Fournit une liste de toutes les entrées de l’historique des pages dans l’arborescence de contenu de StudioCMS.
  • /studiocms_api/rest/v1/pages/[id]/history/[id] : Fournit des détails sur une entrée spécifique de l’historique des pages dans l’arborescence de contenu de StudioCMS.
  • /studiocms_api/rest/v1/settings/ : Fournit les paramètres de StudioCMS pour le projet en cours.
  • /studiocms_api/rest/v1/users/ : Fournit une liste de tous les utilisateurs du projet StudioCMS.
  • /studiocms_api/rest/v1/users/[id] : Fournit des détails sur un utilisateur spécifique dans le projet StudioCMS.