Reference Information › Application Catalog Reference Guide › Web Service Applications › WS_API_SAMPLE - Web Services API Sample Application

WS_API_SAMPLE - Web Services API Sample Application

Latest Version: 1.0.7-1

The WS_API_SAMPLE application provides an example of how to build a simple portal application that accesses the CA AppLogic® Web Service API application that is, WS_API. This application is provided to guide developers of portals and applications which issue Web API requests to an instance of the WS_API application running on a CA AppLogic® grid.

Boundary

Important! The IP addresses configured in the vpn_out_ip, in_usr_ip, and net_out_ip properties must be IP addresses available on your grid. You can locate your IP addresses, netmask, gateway and DNS servers on the dashboard of your grid.

Resources

Volumes

The BackupHelper application has the following volume:

Overview

The WS_API_SAMPLE application must be configured to access the instance of WS_API running on a grid. Before starting this application, start an instance of WS_API application, then configure the WS_API_SAMPLE in the instance of WS_API application.

To configure the WS_API_SAMPLE

1. Access the portal script residing on bin sub-directory of the portal volume of the application
2. Set the IP variable to usr_ip to issue HTTP or HTTPS based requests to the WS_API application or to aux to issue HTTP based requests over a VPN tunnel
3. Edit the VDC info so that it matches the vdcs.conf on the WS_API application. For instance when specifying the grid and location, the command is as follows:

   # 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>
   

The WS_API_SAMPLE can be configured to work in one of the following modes:

• HTTP
• HTTPS
• VPN Tunnel

Using HTTP

In this mode, the portal uses regular HTTP based interface to issue API requests to the instance of WS_API application.
For example, curl "http://usr_ip/api/v1/app/list?vdc=mygrid1".

Using HTTPS

In this mode, the portal uses secure HTTP based interface that is, HTTPS to issue API requests to the instance of WS_API application. For this to work, the api_client.pem key should be copied to the keys sub-directory on the portal volume of the WS_API_SAMPLE application.
For example, curl -k -E /mnt/fs/keys/api_client.pem "https://usr_ip/api/v1/app/list?vdc=mygrid1".

Using VPN Tunnel

In this mode, the portal uses a regular HTTP based interface to issue API requests to the instance of WS_API application through a secure VPN tunnel. To create the tunnel, simple copy the client.xxxxxxxxxxxxxxxxxxxxxxxxx.key, client.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.crt and ca.crt generated on the server sub-directory of the vpn_key volume of the instance of WS_API application to the client sub-directory of the vpn_key volume of the WS_API_SAMPLE application. A secure tunnel is created once the out_vpn component is started.
For example, curl "http://aux/api/v1/app/list?vdc=mygrid1".

Note: The VPN component needs to be activated by opening the UI and unchecking the "Standby" option.

To access the portal through a web browser, point the browser to http://in_usr_ip/api/portal.

Application Architecture

CA AppLogic® Web Services 'WS_API_SAMPLE' application infrastructure is show below:

It has the following components:

• one firewalled input gateway - supports HTTP and HTTPS based access to the portal
• one VPN client - issues API requests through a secure tunnel to the VPN Server in the WS_API application
• one firewalled net gateway - issues HTTP and HTTPS based API requests to the usr_ip of the WS_API application
• a web server - runs the sample portal
• a Linux appliance - to issue command line based requests
• a centralized configuration file storage

Notes

Open source and third-party software used

The following open source third-party software is installed on the portal volume.