API REST d'exécution LNK

Installation de l'API REST LNK dans un serveur Web

Conditions préalables :

• Un serveur Web qui prend en charge des conteneurs Servlet 3.0, tel que Tomcat, Glassfish ou Jetty.

Configuration du fichier de configuration tx-rest.properties

Le fichier de configuration tx-rest.properties est installé dans le répertoire d'installation (install_dir). Les commentaires dans le fichier expliquent chaque propriété.

Définissez au moins les propriétés suivantes dans le fichier tx-rest.properties. Les répertoires que vous spécifiez dans le fichier de configuration doivent être des répertoires existants :

• map.dirs – Un ou plusieurs répertoires qui contiennent les fichiers de mappe compilés.
• catalog.dir – Répertoire dans lequel le fichier de catalogue de mappe doit être créé.
• work.dir – Répertoire des fichiers temporaires utilisés lors de l'exécution de la mappe.
• redis.host – Hôte (et port) du serveur Redis. Par défaut, il est défini sur localhost.
• exec.log.dir – Répertoire dans lequel sont écrits les journaux d'exécution de mappe.

Activation de l'authentification de l'API REST d'exécution

Si authentication.enabled est défini sur true, les appels d'API REST seront authentifiés à l'aide du authentication.server. spécifié. La valeur par défaut est false. Pour activer l'authentification de l'API REST, spécifiez authentication.enabled sur true.

La valeur par défaut authentication.server est https://localhost:8443, pour utiliser les serveurs LNK s'exécutant à distance, modifiez la valeur pour qu'elle pointe vers l'URL authentication.server.

Par exemple : authentication.server=https://<ipaddress>:<port>

• Où <ipaddress> est l'adresse IP de l'installation du serveur d'authentification (ou son nom d'hôte).
• <port> est le port sur lequel le serveur d'authentification écoute les demandes (en général, le numéro de port est 8443).

Pour activer l'authentification de l'AP REST d'exécution LNK, modifiez les paramètres authentication.server :

1. Définissez la valeur authentication.enabled sur true pour activer l'authentification.
2. Entrez le port IP correct de l'installation du serveur LNK. Par exemple,

   https://<LNK server IP>:8443

   Remarque : Assurez-vous que l'adresse TCP <LNK server IP>:8443 n'est pas bloquée par le pare-feu ou qu'elle est visible dans le conteneur Rest, si l'installation du conteneur est effectuée.
3. Installez l'API REST d'exécution, Docker ou tomcat install.
4. Utilisez la nouvelle option d'authentification. Par exemple, l'API de session d'exécution LNK-REST pour créer des jetons
5. Utilisez le jeton ou l'authentification de base pour appeler d'autres appels REST LNK afin de parcourir l'API REST d'exécution LNK et d'y accéder.
6. Ouvrez les URL SWAGGER dans le navigateur :
   • https://<LNK runtime REST API IP>:<LNK runtime REST API PORT>/hip-rest/api-docs?url=openapi.json
   • https://< LNK runtime REST API IP >:< LNK runtime REST API PORT >/hip-rest/api-docs?url=v2/docs

Où LNK Runtime REST API IP est l'IP HÔTE de la machine sur laquelle l'API REST est installée. LNK Runtime REST API PORT est le port d'API, par exemple localhost:9443.

Configuration de l'environnement de serveur Web

Vous devez définir des variables d'environnement pour permettre à l'API de trouver le fichier JAR LNK et les fichiers de bibliothèque.

Si vous utilisez Inst, vous pouvez choisir l'une des méthodes suivantes pour configurer les variables d'environnement :

• La session qui démarre Tomcat peut appeler le script $DTX_HOME_DIR/setup (ou %DTXHOME%/DTXCommon.bat sur les systèmes Windows) pour configurer les variables d'environnement LNK.

export DTX_HOME_DIR=" <install-dir>"
export CATALINA_OPTS="$CATALINA_OPTS -Djava.library.path=$DTX_HOME_DIR/libs"
export LD_LIBRARY_PATH="$DTX_HOME_DIR/libs:$DTX_HOME_DIR/java/bin:$DTX_HOME_DIR/java/lib/server:$DTX_HOME_DIR/java/lib:$DTX_HOME_DIR/unixODBC/linux/lib:$LD_LIBRARY_PATH"
export ODBCINST="$DTX_HOME_DIR/unixODBC/etc/odbcinst.ini"
export ODBCINI="$DTX_HOME_DIR/unixODBC/etc/odbc.ini"

Déploiement du fichier WAR

Le fichier hip-rest.war implémente l'API REST pour LNK. Il est installé dans le répertoire $DTX_HOME_DIR/restapi. Déployez le fichier .war comme toute autre application Web. Si vous utilisez Tomcat, copiez le fichier .war dans le dossier webapps Tomcat, manuellement ou via la console Web Tomcat (par exemple, http://<HIP Runtime REST API server >:8080/manager/html/lis).

Selon la façon dont votre serveur Web est configuré, vous devrez peut-être redémarrer le serveur après avoir déployé l'application.

La console du serveur Web affiche si l'application a démarré correctement. Si l'application n'a pas démarré correctement, recherchez les erreurs liées à l'application hip-rest dans le fichier journal du serveur Web.

Validation du déploiement

Une fois que vous avez déployé l'application hip-rest, elle s'exécute par défaut avec une racine de contexte de hip-rest.

{
version: "1.0.0",
status: "OK",
name: "HIP Runtime REST API",
up_time: "0 days, 0 hours, 0 mins, 25 secs"
}

Documentation Swagger

Pour afficher la documentation Swagger pour les API REST LNK, entrez l'URL suivante dans un navigateur :

http://< HIP Runtime REST API server>:8080/hip-rest/api-docs?url=/hip-rest/openapi.json

Vous pouvez appeler les API directement à partir de l'interface Swagger en cliquant sur Essayer sous chaque définition d'API.

Exécution dans un conteneur Docker

Utilisez ces instructions pour exécuter l'API REST Link dans un conteneur Docker. Ces instructions s'appliquent uniquement à la plateforme Linux.

rest_docker.sh start

Si vous souhaitez appeler l'API sur un port différent (8080 par défaut), modifiez le script rest_docker.sh. Par exemple, pour utiliser le port 4444, modifiez la commande docker run en -p 4444:8080.