Initiation au service REST pour Web Content Manager

Avant de commencer à utiliser le service REST pour Web Content Manager, familiarisez-vous avec son fonctionnement et son utilisation.

The REST service for Web Content Manager is a collection of web services that are compliant with the Atom Publishing Protocol. Il permet d'accéder au contenu Web, y compris aux versions et aux états de flux de travaux, via HTTP. Il est conçu conformément au style architectural REST (REpresentational State Transfer).

Les services REST facilitent la génération de contenu interactif qui peut être modifié directement par les utilisateurs du site. Des outils d'édition intégrés et réactifs peuvent être créés en imbriquant du code HTML et JavaScript dans les composants de contenu Web qui établissent un lien au service REST pour afficher ou mettre à jour le contenu de façon asynchrone. (Ajax)

HTTP rend l'intégration aux clients distants plus faciles qu'avec une API traditionnelle. Les fonctions Web Content Manager peuvent être visibles pour les systèmes distants sans qu'il ne soit nécessaire d'ajouter des composants côté serveur, comme JSP, pour accéder aux API Java. HTTP permet à ces services de fonctionner de façon transparente dans votre infrastructure, qui peut contenir un pare-feu, des serveurs proxy et des caches.

Remarque : Les exemples de cette section qui contiennent du code XML incomplet ou du code XML sans déclaration d'espace de nom utilisent les déclarations suivantes :
  • xmlns:atom="http://www.w3.org/2005/Atom"
  • xmlns:app="http://www.w3.org/2007/app"
  • xmlns:wcm="http://www.ibm.com/xmlns/wcm"

Points d'entrée de service

Les adresses URL qui composent le service REST peuvent changer selon l'édition, ou même dans les mises à jour mineures. Par conséquent, il est recommandé de ne jamais enregistrer sous forme de signet ni de générer une adresse URL sauf si elle désigne un point d'entrée défini.
Document de service du protocole de publication Atom
/wps/mycontenthandler/model/service

Ce document de service inclut les points d'entrée de tous les services REST du portail. Lorsque vous parcourez un contenu, vous devez d'abord extraire le document de service. Le document de service AtomPub décrit les collections de niveau supérieur d'un service APP. Ces collections représentent des bibliothèques et d'autres types de contenu accessibles via le service.

Les requêtes de contenu Web peuvent être stockées dans certaines collections. Ainsi, les administrateurs peuvent limiter la portée et la structure des requêtes, et les lier à des adresses URL spécifiques, auxquelles tous les utilisateurs authentifiés peuvent accéder pour extraire les résultats sous forme de flux Atom.

Service POC
Si un objet de contenu spécifique est connu, vous pouvez y accéder directement via le service POC ; le service POC peut aussi être utilisé pour rechercher une adresse URL appropriée pour le contenu. L'identité d'un élément de contenu dans le service REST est représentée par son URI POC. L'URI POC se trouve dans l'élément ID des documents d'entrée Atom qui représente l'objet de contenu.
Requêtes
Alors que les requêtes peuvent être stockées dans le service REST, elles peuvent aussi être exécutées directement à partir d'un emplacement unique :
/wcmrest/query
Cette souplesse est soumise aux contrôles de sécurité pour éviter que les utilisateurs ne surchargent par inadvertance les serveurs de production avec des requêtes complexes.

Niveaux d'accès du service REST

Pour pouvoir utiliser le service REST pour Web Content Manager, un utilisateur client doit posséder le rôle "utilisateur" ou un rôle supérieur dans la ressource virtuelle WCM REST SERVICE. Tous les utilisateurs authentifiés sont affectés au rôle "utilisateur" par défaut.

Un administrateur peut éditer la ressource virtuelle WCM REST SERVICE. Click the Administration menu icon. Then, click Access > Resource Permissions. Cliquez ensuite sur Ressources virtuelles.
Remarque : Les droits d'accès aux bibliothèques appropriés doivent être configurés pour pouvoir créer le contenu.
Tableau 1. Rôles utilisateur REST
En-tête En-tête
Utilisateur Les utilisateurs possédant le rôle "utilisateur" peuvent :
  • utiliser les objets de contenu Web et exécuter des requêtes définies.
Editeur Les utilisateurs possédant le rôle "éditeur" peuvent :
  • utiliser les objets de contenu Web et exécuter des requêtes définies.
  • exécuter des requêtes personnalisées via le chemin d'accès suivant : . /wcmrest/query
Gestionnaire Les utilisateurs possédant le rôle "gestionnaire" peuvent :
  • utiliser les objets de contenu Web et exécuter des requêtes définies.
  • exécuter des requêtes personnalisées via le chemin d'accès suivant : . /wcmrest/query
  • créer, lire, mettre à jour et supprimer des requêtes définies.