Mise en route d'HCL Experience API - Tech Preview

Procédez comme suit pour démarrer avec HCL Experience API - Tech Preview.

Mise en route

  1. Téléchargez les binaires d'installation d'HCL Experience API - Tech Preview. Connectez-vous à HCL Software, puis à HCL Software Licensing Portal afin de télécharger les fichiers à partir de vos autorisations d'utilisation d'HCL Digital Experience.
  2. Décompressez les binaires d'installation d'HCL Experience API - Tech Preview et, depuis un terminal, accédez au dossier décompressé.
  3. Vérifier que le dossier décompressé contient hcl-dx-experience-api-image-v0.5.0.<YOUR_BUILD_NUMBER>.tar.gz et README.md.
  4. Chargez l'image Docker HCL Experience API - Tech Preview à l'aide de la commande suivante :
    docker load --input hcl-dx-experience-api-image-v0.5.0.<YOUR_BUILD_NUMBER>.tar.gz
  5. Vérifiez si l'image Docker a été chargée à l'aide de la commande suivante :
    docker image ls
  6. Exécutez la commande Docker suivante pour afficher l'image Docker HCL Experience API - Tech Preview :
    docker run -it -p 3000:3000 -p 3001:3001 hcl/dx/experience-api:v0.5.0.<YOUR_BUILD_NUMBER>
    • Vous pouvez modifier les valeurs les plus courantes en transmettant les paramètres comme suit :
      docker run -it -p 3000:3000 -p 3001:3001 -e PORTAL_HOST=172.16.1.4 -e PORTAL_PORT=30015 hcl/dx/experience-api:v0.5.0.<YOUR_BUILD_NUMBER>
    • Si vous souhaitez utiliser https pour connecter HCL Portal pour des raisons de sécurité, la commande permettant de démarrer serait la suivante :
      docker run -it -p 3000:3000 -p 3001:3001 -e PORTAL_HOST=172.16.1.4 -e PORTAL_PORT=30015 -e PORTAL_SSL_ENABLED=true hcl/dx/experience-api:v0.5.0.<YOUR_BUILD_NUMBER>
    • Si vous souhaitez mettre à jour le CORS_ORIGIN, la commande permettant de démarrer serait la suivante :
      docker run -it -p 3000:3000 -p 3001:3001 -e PORTAL_HOST=172.16.1.4 -e PORTAL_PORT=30015 -e CORS_ORIGIN="http://localhost:3002, http://localhost:3003" hcl/dx/experience-api:v0.5.0.<YOUR_BUILD_NUMBER>
  7. Vérifiez si http://<HOST>:<PORT>dx/api/core/v0/explorer est accessible et affiche l'explorateur d'HCL Experience API - Tech Preview (par ex., http://127.0.0.1:3000/dx/api/core/v0/explorer).
  8. Vérifiez si l'application GraphQL est accessible via l'URL http://<HOST>:<GRAPHQL_PORT>dx/api/core/v0/graphql (par ex., http://127.0.0.1:3001/dx/api/core/v0/graphql).
  9. Pour vérifier si HCL Experience API - Tech Preview est correctement connectée à HCL Digital Experience 9.5, exécutez la commande suivante. Les données d'identification doivent consister en un nom d'utilisateur authentifié et un mot de passe :
    curl -X POST "http://<HOST>:<PORT>dx/api/core/v0/auth/login" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"username\":\"<USER_NAME>\",\"password\":\"<PASSWORD>\"}"
  10. Pour vous assurer que la connexion est réussie, la réponse doit être la suivante :
    {"statusCode":200,"message":"Login Successful","data":{"UId":"(USER_NAME)"}}