HCL Commerce API REST

La documentación de API REST de HCL Commerce contiene una lista de los recursos que proporciona la API REST de HCL Commerce. Cada recurso REST contiene información como URL, descripciones y datos de entrada y salida de ejemplo.

Consideraciones sobre seguridad

Por razones de seguridad, Swagger no debe exponerse al entorno de producción en tiempo real.
Puede restringir su exposición de las siguientes maneras:
- Si los puertos de la API de REST no son necesarios para exponerse externamente, asegúrese de que están bloqueados por las reglas del firewall. Estos puertos incluyen 5443, 9443, 8000, 30800 y 30900.
- Si necesita exponer estos puertos:
  1. Deshabilite la API de detección de REST para Transaction server. Para obtener más información, consulte Habilitar e inhabilitar la API de REST Discover.
  2. Asegúrese de configurar el servidor web para bloquear el acceso a los siguientes puntos finales swagger:
    - 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

Interfaz de usuario de Swagger

A partir de la versión 9.1.6, HCL Commerce es compatible con la especificación OpenAPI 3.0. Puede usar la especificación Swagger para probar cualquier API de RESTful que esté documentada en los archivos OAS.

Acceso a la interfaz de usuario de una versión de Swagger posterior a la 9.1.6

Puesto que la interfaz de usuario de Swagger no se proporciona junto con las API de REST a partir de la versión 9.1.6, debe configurar una copia local del editor o de la interfaz de usuario para ver de forma segura las especificaciones de la OpenAPI. Para obtener más información, consulte Configuración de una instancia de Swagger local.

Para utilizar especificaciones de Swagger más antiguas generadas a partir de anotaciones, establezca la propiedad OAS3Enabled de wc-component.xml en "false".

Interfaz de usuario de Swagger para acceder a las especificaciones de Swagger anteriores (1.x)

Puesto que las especificaciones de Swagger anteriores (1.x) no son compatibles con el editor de Swagger más reciente, no es posible abrirlo en la última interfaz de usuario de Swagger. Por lo tanto, es necesario configurar una versión anterior de la instancia de la interfaz de usuario de Swagger para ver las especificaciones de Swagger 1.x.

Siga las siguientes instrucciones para desplegar la interfaz de usuario de Swagger anterior.

Para instalar la interfaz de usuario de Swagger de forma local, visite https://github.com/swagger-api/swagger-ui/tree/v2.2.9.
Para instalar la interfaz mediante una imagen de Docker deberá hacer lo siguiente:
- Extraiga la imagen utilizando el comando docker pull swaggerapi/swagger-ui:v2.2.9
- Cree el contenedor utilizando el comando docker run -d -p 8080:8080 swaggerapi/swagger-ui:v2.2.9

Note: Si está utilizando una versión anterior a 9.1.6, puede seguir utilizando la interfaz de usuario de Swagger. Para obtener más información, consulte Interfaz de usuario de Swagger y Visualización de la API de REST mediante Swagger en versiones anteriores a 9.1.6.

Visualización de las especificaciones de Swagger

Puede ver las especificaciones de Swagger aquí:

Visualización de las especificaciones de Swagger en el entorno Toolkit o Runtime

Para ver las API de REST de HCL Commerce, acceda a la especificación de Swagger en las siguientes direcciones.

Para las API de REST de escaparate de HCL Commerce: https://<hostname>:5443/wcs/resources/api.
Para acceder a las especificaciones OpenAPI3.0 de un recurso determinado: https://<hostname>:5443/wcs/resources/api/resource/<component>.
Por ejemplo, para acceder a las especificaciones de Price, utilice la siguiente URL: https://<hostname>:5443/wcs/resources/api/resource/price.
Para las API de REST de herramientas: https://<hostname>:8000/rest/admin/v2/swagger.
Para las API de REST XC: https://<hostname>:9443/commerceue/extension/api.
Para las API de REST de consulta: http://<hostname>:30900/search/resources/v3/api-docs
Para las APIs REST de Ingest: http://<hostname>:30800/v3/api-docs

Note: Los puertos pueen ser diferentes para un entorno de Toolkit.