Web Service Applications › WS_API_SAMPLE - Web Services API Sample Application

WS_API_SAMPLE - Web Services API Sample Application

Latest Version: 1.0.0-1

The WS_API_SAMPLE application provides an example of how to build a simple portal application that accesses the CA AppLogic® for System z 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® for System z 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 CA AppLogic® for System z grid. You can find them, together with the netmask, gateway, and DNS servers on the dashboard of your grid.

Resources

Application Volumes

The application itself uses several volumes. They are part of the application and are already configured into the appliance instances. No volumes require configuration on the application boundary.

Overview

To access the instance of WS_API running on a grid, configure the WS_API_SAMPLE application. Before you start this application, start an instance of WS_API application as explained here. The WS_API_SAMPLE can then be configured regarding properties that are set in the instance of WS_API application.

To configure WS_API_SAMPLE, modify the portal volume:

• Set the IP variable in the /bin/portal and /bin/job scripts to one of the following values:
  • usr_ip to issue HTTP- or HTTPS-based requests to the WS_API application
  • aux to issue HTTP-based requests over a VPN tunnel
• Ensure that the application template name listed in the portal script matches the template available on the grid.
• Add the list of IP addresses available for the provisioned application in the file ip-list under /mnt/content/data.
• Edit VDC info so that it matches the vdcs.conf on the WS_API application, for example:

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

  If mygrid1 and mygrid2 are two VDCs running in Dallas and San Diego respectively, then change the HTML code to:

  # 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® for System z Web Services 'WS_API_SAMPLE' application infrastructure 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 the 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.