Información de referencia › Guía de referencia del catálogo de la aplicación › Aplicaciones de servicio Web › WS_API_SAMPLE: aplicación de muestra de API de servicios Web

WS_API_SAMPLE: aplicación de muestra de API de servicios Web

Última versión: 1.0.3-1

La API de servicio Web sólo está disponible en la versión de producción de CA AppLogic 2.9 y en versiones posteriores.

La aplicación WS_API_SAMPLE ofrece un ejemplo de cómo generar una aplicación de portal sencilla que acceda a la aplicación API de servicio Web de CA AppLogic, es decir, WS_API. Esta aplicación se proporciona para guiar a los desarrolladores de portales y aplicaciones que envían solicitudes API de Web a una instancia de la aplicación WS_API que se ejecuta en un grid de CA AppLogic.

Propiedades de límite de la aplicación 'WS_API_SAMPLE' de servicios Web de CA AppLogic

Importante: Las direcciones IP configuradas en las propiedades vpn_out_ip, in_usr_ip y net_out_ip deben ser direcciones IP disponibles en el grid de CA AppLogic. Puede encontrarlas, junto con la máscara de red, la puerta de enlace y los servidores DNS, en el cuadro de mandos del grid. Estamos trabajando para hacer posible que CA AppLogic proporcione estas direcciones automáticamente.

Recursos de la aplicación

Volúmenes de aplicación

La aplicación BackupHelper tiene el volumen siguiente:

Detalles de implementación

Arquitectura de la aplicación

BackupHelper los componentes siguientes:

• Una puerta de enlace de entrada con cortafuegos
• Un servidor Web
• Un servidor de archivos de contenido
• Una puerta de enlace de salida con cortafuegos

Descripción general

La aplicación WS_API_SAMPL tiene que configurarse para acceder a la instancia de WS_API que se ejecuta en un grid de CA AppLogic. Antes de iniciar esta aplicación, inicie una instancia de la aplicación WS_API tal y como se explica aquí. A continuación, se puede configurar WS_API_SAMPLE con respecto a las propiedades que están establecidas en la instancia de la aplicación WS_API.

Cómo configurar WS_API_SAMPLE

1. Edite el script del portal que reside en el subdirectorio bin del volumen del portal de la aplicación y establezca la variable IP en el script de la siguiente manera:
2. Establezca la variable IP como usr_ip, para emitir las solicitudes basadas en HTTP o HTTPS a la aplicación WS_API, o como aux, para emitir solicitudes basadas en HTTP mediante un túnel VPN
3. Edite la información VDC para que coincida con el valor de vdcs.conf en la aplicación WS_API. Por ejemplo:

   # EDIT VDC info here
   <p>
   <label for="location">Seleccionar ubicación: </label>
   <select name="location">
   <option value="dallas">Dallas, TX, EE. UU.</option>
   <option value="sandiego">San Diego, CA, EE. UU.</option>
   <option value="japan">Tokio, Japón</option>
   <option value="netherlands">Ámsterdam, Países Bajos</option>
   </select>
   </p>
   Lo anterior se debería cambiar a las aplicaciones SDV que se configuran en la aplicación WS_API. Si mygrid1 y mygrid2 son dos aplicaciones SDV que se ejecutan en Dallas y en San Diego respectivamente, el código HTML anterior debería cambiarse de la siguiente manera: 
   # EDIT VDC info here
   <p>
   <label for="location">Seleccionar ubicación: </label>
   <select name="location">
   <option value="mygrid1">Dallas, TX, EE. UU.</option>
   <option value="mygrid2">San Diego, CA, EE. UU.</option>
   </select>
   </p>
   

Se puede configurar WS_API_SAMPLE para que funcione en uno de los modos siguientes:

• HTTP
• HTTPS
• Túnel VPN

Uso de HTTP

En este modo, el portal utilizar una interfaz basada en HTTP normal para emitir solicitudes API a la instancia de la aplicación WS_API.
Por ejemplo, curl "http://usr_ip/api/v1/app/list?vdc=mygrid1".

Uso de HTTPS

En este modo, el portal utilizar una interfaz basada en HTTP seguro, es decir HTTPS, para emitir solicitudes API a la instancia de la aplicación WS_API. Para que esto funcione, la clave api_client.pem se debería copiar al subdirectorio de claves del volumen del portal de la aplicación WS_API_SAMPLE.
Por ejemplo, curl -k -E /mnt/fs/keys/api_client.pem "https://usr_ip/api/v1/app/list?vdc=mygrid1".

Uso del túnel VPN

En este modo, el portal utilizar una interfaz basada en HTTP normal para emitir solicitudes API a la instancia de la aplicación WS_API a través de un túnel VPN seguro. Para crear el túnel, tan solo hay que copiar los client.xxxxxxxxxxxxxxxxxxxxxxxxx.key, client.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.crt y ca.crt generados en el subdirectorio del servidor del volumen vpn_key de la instancia de la aplicación WS_API al subdirectorio de cliente del volumen vpn_key de la aplicación WS_API_SAMPLE. Se crea un túnel seguro en cuanto se inicia el componente out_vpn.
Por ejemplo, curl "http://aux/api/v1/app/list?vdc=mygrid1".

Para acceder al portal a través de un explorador Web, apunte el explorador a http://in_usr_ip/api/portal

Arquitectura de la aplicación

La infraestructura de la aplicación 'WS_API_SAMPLE' de servicios Web de CA AppLogic se presenta a continuación:

Tiene los componentes siguientes:

• Una puerta de enlace de entrada con cortafuegos: admite las solicitudes basadas en HTTP y HTTPS para acceder al portal
• Un servidor VPN: envía las solicitudes API a través de un túnel seguro al servidor VPN de la aplicación WS_API
• Una puerta de enlace de red con cortafuegos: emite las solicitudes de API basadas en HTTP y HTTPS a usr_ip o a la aplicación WS_API
• Un servidor Web: ejecuta el portal de muestra
• Un dispositivo Linux: para emitir las solicitudes basadas en la línea de comandos
• Un almacenamiento de archivos de configuración centralizado

Notes

Software de fuente abierta y de terceros utilizado

El siguiente software de terceros de fuente abierta está instalado en el volumen portal.