HCL Commerce API REST

La documentation de L'API REST HCL Commerce contient une liste des ressources fournies par l'API REST HCL Commerce. Chaque ressource REST contient des informations, telles que des URL, des descriptions et des exemples de données d'entrée et de données de sortie.

Considérations relatives à la sécurité

Pour des raisons de sécurité, Swagger ne doit pas être exposé dans votre environnement de production opérationnel.
Vous pouvez l'empêcher d'être exposé comme suit :
- Si les ports de l'API REST ne doivent pas être exposés en externe, assurez-vous qu'ils sont bloqués par vos règles de pare-feu. Ces ports incluent 5443, 9443, 8000, 30800 et 30900.
- Si vous devez exposer ces ports :
  1. Désactivez l'API Discovery REST pour le Transaction server. Pour plus d'informations, voir Activation et désactivation de l'API Discovery REST.
  2. Assurez-vous de configurer votre serveur Web de façon à bloquer l'accès aux nœuds finaux swagger suivants :
    - https://hostname:5443/wcs/resources/api
    - https://hostname:8000/rest/admin/v2/swagger
    - https://hostname:9443/commerceue/extension/api
    - https://hostname:30900/search/resources/v3/api-docs
    - https://hostname:30800/v3/api-docs
    - http://localhost:6643/approvals/v3/api-docs

Interface utilisateur Swagger

A partir de la version 9.1.6, HCL Commerce prend en charge la spécification OpenAPI 3.0. Vous pouvez utiliser la spécification Swagger pour tester les API RESTful documentées dans les fichiers OAS.

Accès à l'interface utilisateur Swagger après la version 9.1.6

Etant donné que l'interface utilisateur Swagger n'est pas fournie avec les API REST HCL Commerce à partir de HCL Commerce version 9.1.6, vous devez configurer une copie locale de l'éditeur et de l'interface utilisateur pour afficher en toute sécurité vos spécifications OpenAPI. Pour plus d'informations, voir Configuration d'une instance Swagger locale.

Pour utiliser des spécifications Swagger plus anciennes générées à partir d'annotations, définissez la propriété OAS3Enabled dans wc-component.xml sur false.

Interface utilisateur Swagger pour accéder aux spécifications Swagger plus anciennes (1.x)

Etant donné que les spécifications Swagger plus anciennes (1.x) ne sont pas compatibles avec le dernier éditeur Swagger, vous ne pouvez pas l'ouvrir sur la dernière interface utilisateur Swagger. Par conséquent, la configuration d'une version plus ancienne de l'instance d'interface utilisateur Swagger est requise pour afficher les spécifications 1.x de Swagger.

Suivez les instructions ci-dessous pour déployer l'ancienne interface utilisateur Swagger.

Pour installer l'interface utilisateur Swagger localement, rendez-vous sur https://github.com/swagger-api/swagger-ui/tree/v2.2.9.
Pour installer l'interface à l'aide d'une image Docker :
- Extraire l'image à l'aide de la commande docker pull swaggerapi/swagger-ui:v2.2.9
- Créer le conteneur à l'aide de la commande docker run -d -p 8080:8080 swaggerapi/swagger-ui:v2.2.9

Note: Si vous utilisez une version antérieure à la version 9.1.6, vous pouvez continuer à utiliser l'interface utilisateur Swagger. Pour plus d'informations, voir Interface utilisateur Swagger et Affichage de l'API REST à l'aide de Swagger dans les versions antérieures à la version 9.1.6.

Affichage des spécifications Swagger

Vous pouvez afficher les spécifications Swagger ici :

Affichage des spécifications Swagger dans le kit d'outils ou l'environnement d'exécution

Pour afficher les API REST HCL Commerce, accédez à la spécification Swagger aux adresses suivantes.

Pour les API REST de vitrine HCL Commerce : https://<hostname>:5443/wcs/resources/api.
Pour accéder aux spécifications OpenAPI3.0 d'une ressource spécifique : https://<hostname>:5443/wcs/resources/api/resource/<component>.
Par exemple, pour accéder aux spécifications de Prix, utilisez l'URL suivante : https://<hostname>:5443/wcs/resources/api/resource/price.
Pour les API REST Tooling : https://<hostname>:8000/rest/admin/v2/swagger.
Pour les API REST XC : https://<hostname>:9443/commerceue/extension/api.
Pour les API REST Query : http://<hostname>:30900/search/resources/v3/api-docs
Pour les API REST Ingest : http://<hostname>:30800/v3/api-docs

Note: Les ports peuvent être différents pour un environnement de kit d'outils.