Passer au contenu principal
Le CMS API expose les bases de données personnalisées que vous créez dans Plato CMS. Utilisez-le pour les sites Web, les catalogues, les pages de destination, les portails partenaires et les outils internes nécessitant un contenu structuré provenant d’un espace de travail Plato.

Liste des entrées

Récupérez les entrées avec des champs, des filtres, une pagination et des en-têtes de réponse prévisibles.

Obtenez une entrée

Lisez une seule entrée CMS par identifiant à partir d’une intégration fiable.

Créer une entrée

Ajoutez du nouveau contenu CMS à partir d’un backend, d’un site Web ou d’un outil interne.

Mettre à jour l'entrée

Corrigez ou remplacez le contenu CMS existant en toute sécurité.

Supprimer l'entrée

Supprimez les enregistrements CMS lorsque l’intégration est propriétaire du cycle de vie.

Champs et relations

Comprenez les valeurs, les champs système, les identifiants de relation et le contenu lié.

​
Points de terminaison

GET    /api/public/cms/[modelId]/list
POST   /api/public/cms/[modelId]/list
GET    /api/public/cms/[modelId]/[id]
PATCH  /api/public/cms/[modelId]/[id]
PUT    /api/public/cms/[modelId]/[id]
DELETE /api/public/cms/[modelId]/[id]
modelId peut être l’identifiant de la base de données CMS ou l’identifiant de la base de données. Utilisez des identifiants de base de données lisibles tels que products, locations ou team_members lorsque cela est possible. Ils facilitent la maintenance des URL API.

​
Authentification

Les points de terminaison CMS acceptent : 
Authorization: Bearer plato_your_api_key
ou: 
x-api-key: plato_your_api_key
Les intégrations plus anciennes peuvent utiliser : 
?apiKey=plato_your_api_key
Le rôle clé API doit inclure l’accès CMS.

​
Champs système

Chaque entrée peut inclure :
ChampSignification
idIdentifiant d’entrée.
createdAtDate de création de l’entrée.
updatedAtDate de la dernière mise à jour, lorsqu’elle est disponible.
Ces champs sont sélectionnés par défaut lorsqu’aucune requête fields n’est envoyée.

​
En-têtes de réponse

Les réponses de liste et d’entrée incluent les en-têtes de métadonnées CMS.
En-têteSignification
x-cms-model-idL’identifiant de la base de données interne qui correspond à la demande.
x-cms-model-identifierL’identifiant de base de données lisible, une fois configuré.
x-cms-totalNombre total d’entrées pour les demandes de liste.
x-cms-limitLimite utilisée par la demande de liste.
x-cms-offsetDécalage utilisé par la demande de liste.
x-cms-has-more1 lorsque plusieurs lignes sont disponibles.

​
Débit typique

  1. Créez ou ouvrez la base de données CMS dans Plato.
  2. Confirmez l’identifiant de la base de données et les clés de champ.
  3. Créez une clé API avec un accès CMS.
  4. Répertoriez les entrées avec les champs dont votre application a besoin.
  5. Utilisez la création, la mise à jour et la suppression uniquement à partir du code du serveur approuvé.
Pour la configuration du schéma, voir Outils de développement CMS.