Informations de référence › Manuel de référence du catalogue d'application › Applications de services Web › WS_API_SAMPLE : exemple d'application API de services Web

WS_API_SAMPLE : exemple d'application API de services Web

Dernière version : 1.0.3-1

L'API de services Web est uniquement disponible dans la version de production 2.9 de CA AppLogic et les versions ultérieures.

L'application WS_API_SAMPLE fournit un exemple de procédure pour la création d'une application de portail simple qui accède à l'application API de services Web de CA AppLogic, c'est-à-dire WS_API. Cette application est fournie pour guider les développeurs de portails et d'applications qui envoient des requêtes API Web à une instance de l'application WS_API en cours d'exécution sur une grille CA AppLogic.

Propriétés du périmètre de l'application "WS_API_SAMPLE" des services Web de CA AppLogic

Important : Les adresses IP configurées dans les propriétés vpn_out_ip, in_usr_ip et net_out_ip doivent être des adresses IP disponibles sur votre grille CA AppLogic. Elles figurent, avec le masque réseau, la passerelle et les serveurs DNS, dans le tableau de bord de votre grille. Des travaux sont en cours pour qu'à l'avenir CA AppLogic fournisse ces adresses automatiquement.

Ressources d'application

Volumes virtuels d'application

L'application BackupHelper comporte le volume suivant :

Détails d'implémentation

Architecture de l'application

BackupHelper contient les composants suivants :

• Une passerelle d'entrée derrière un pare-feu
• Un serveur Web
• Un serveur de fichiers de contenu
• Une passerelle de sortie réseau derrière un pare-feu

Présentation

L'application WS_API_SAMPLE doit être configurée pour accéder à l'instance de WS_API s'exécutant sur une grille CA AppLogic. Avant de lancer cette application, démarrez une instance de l'application WS_API comme expliqué ici. Vous pouvez alors configurer WS_API_SAMPLE concernant des propriétés qui sont définies dans l'instance de l'application WS_API.

Pour configurer WS_API_SAMPLE

1. Modifiez le script de portail résidant dans le sous-répertoire bin du volume de portail de l'application et définissez la variable IP dans le script sur :
2. Définissez la variable IP sur usr_ip pour envoyer des requêtes HTTP ou HTTPS à l'application WS_API ou sur aux pour publier des requêtes HTTP via un tunnel VPN.
3. Modifiez les informations VDC pour qu'elles correspondent à vdcs.conf sur l'application WS_API. Par exemple :

   # EDIT VDC info here
   <p>
   <label for="location">Select Location: </label>
   <select name="location">
   <option value="dallas">Dallas, TX, USA</option>
   <option value="sandiego">San Diego, CA, USA</option>
   <option value="japan">Tokyo, Japan</option>
   <option value="netherlands">Amsterdam, Netherlands</option>
   </select>
   </p>
   L'opération susmentionnée doit modifier les VDC qui sont configurés dans l'application WS_API. Si mygrid1 et mygrid2 sont deux VDC s'exécutant à Dallas et à San Diego respectivement, alors, le code HTML ci-dessus doit être remplacé par : 
   # EDIT VDC info here
   <p>
   <label for="location">Select Location: </label>
   <select name="location">
   <option value="mygrid1">Dallas, TX, USA</option>
   <option value="mygrid2">San Diego, CA, USA</option>
   </select>
   </p>
   

Vous pouvez configurer WS_API_SAMPLE pour travailler dans un des modes suivants :

• HTTP
• HTTPS
• Tunnel VPN

Utilisation d'HTTP

Dans ce mode, le portail utilise l'interface HTTP standard pour envoyer les requêtes API à l'instance de l'application WS_API.
Par exemple, bouclez "http://usr_ip/api/v1/app/list?vdc=mygrid1".

Utilisation d'HTTPS

Dans ce mode, le portail utilise l'interface HTTP sécurisée, c'est-à-dire HTTPS, pour envoyer les requêtes API à l'instance de l'application WS_API. Pour que cela fonctionne, la clé api_client.pem doit être copiée dans le sous-répertoire de clés sur le volume de portail de l'application WS_API_SAMPLE.
Par exemple, bouclez -k -E /mnt/fs/keys/api_client.pem "https://usr_ip/api/v1/app/list?vdc=mygrid1".

Utilisation d'un tunnel VPN

Dans ce mode, le portail utilise l'interface HTTP standard pour envoyer les requêtes API à l'instance de l'application WS_API via un tunnel VPN sécurisé. Pour créer le tunnel, il vous suffit de copier les éléments client.xxxxxxxxxxxxxxxxxxxxxxxxx.key, client.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.crt et ca.crt générés dans le sous-répertoire de serveur du volume vpn_key de l'instance de l'application WS_API vers le sous-répertoire client du volume vpn_key de l'application WS_API_SAMPLE. Un tunnel sécurisé est créé une fois que le composant out_vpn est lancé.
Par exemple, bouclez "http://aux/api/v1/app/list?vdc=mygrid1".

Pour accéder au portail via un navigateur Web, faites pointer le navigateur vers l'adresse http://in_usr_ip/api/portal

Architecture de l'application

L'infrastructure de l'application "WS_API_SAMPLE" des services Web de CA AppLogic est illustrée ci-dessous :

Elle contient les composants suivants.

• Une passerelle d'entrée derrière un pare-feu : prend en charge l'accès HTTP et HTTPS au portail.
• Un client VPN : envoie les requêtes API, via un tunnel sécurisé, au serveur VPN de l'application WS_API.
• Une passerelle NET derrière un pare-feu : envoie les requêtes API HTTP et HTTPS à l'adresse IP usr_ip de l'application WS_API.
• Un serveur Web : exécute le portail modèle.
• Une appliance Linux : publie les requêtes de ligne de commande.
• Un stockage centralisé des fichiers de configuration.

Commentaires

Open source et logiciels tiers utilisés

Les logiciels tiers Open Source suivants sont installés sur le volume de portail.