Integrate with the API Mediation Layer

dm20
The Zowe API Mediation Layer (API ML) consolidates mainframe RESTful API services at a single, secure point of access and offers a cloud-like experience through high-availability, scalability, dynamic discovery, and provides API documentation of services that are registered with the API ML.
For more information about the API ML, see the Zowe API ML.
The Database Management Data Service (DBM Data Service) RESTFUL API services are included in the API Mediation Layer for z/OS for the following CA Database Management Solutions for Db2 for z/OS:
  • CA SYSVIEW® Performance Management Option for DB2
    (CA SYSVIEW for DB2)
  • CA Detector® for DB2 for z/OS
    (CA Detector)
This graphic is the Zowe Conformant API Mediation Layer Badge.
The DBM Data Service RESTful API services have earned Zowe Conformant status. The Zowe Conformance Program gives users confidence that when they use a product, application, or distribution that leverages Zowe, they can expect a high level of common functionality, interoperability, and user experience. The Zowe API Mediation Layer consolidates mainframe RESTful API services into a single, secure point of access. For information about which REST APIs are conformant with the Zowe API Mediation Layer, see the Open Mainframe Project site.
API Mediation Layer Components Overview
The API Mediation layer offers the following enterprise, cloud-like features:
  • Consistent Access
    API call routing and standardization of API service URLs through the built-in Gateway component provide you with a consistent way of accessing mainframe APIs at a static IP location.
  • Dynamic Discovery
    You no longer need to determine the location and status of API services as the Discovery Service component does this automatically.
  • Encrypted Communication
    API Mediation Layer facilitates secure communication across both internal components and discovered API services.
  • High-Availability
    API Mediation Layer is designed with high-availability and scalability in mind.
  • Presentation of Services
    The API Catalog component provides easy access to discovered API services and their associated documentation in a user-friendly manner. Access to the contents of the API catalog is controlled through a z/OS security facility.
  • Redundancy and Scalability
    You can increase API service throughput by starting multiple API service instances without any changes in configuration.
Integration with the API Mediation Layer is optional. You can still use the CA SYSVIEW for DB2 and CA Detector REST APIs without the API Mediation Layer. However, Integration with the API Mediation Layer provides additional benefits to your API service.
Install the API Mediation Layer
Download the API Mediation Layer package using one of the following methods:
  • Acquire the
    CA Brightside API Mediation Layer
    pax file as part of the CA Brightside Enterprise software package. For more information, see the CA Brightside API Mediation Layer documentation.
  • Install the API Mediation Layer as part of the Zowe open source project. For more information, see the Zowe documentation.
Integrate with the API Mediation Layer
Integrate the CA Database Management for DB2 for z/OS REST APIs with the API Mediation Layer to make the REST API discoverable and available in the API Catalog. To enable this integration, configure the Database Management Data Service (DBM Data Service).  Specify the following parameter values during customization of the DBM Data Service using the DBM for Db2 Configuration Utility:
  • Specify a unique service id that the Data Service requires to identify itself to the API Catalog. For example, cadbmds01.
  • Specify the title of the service that is displayed in the API Catalog. For example, CA DBM for DB2 Tools API Data Service.
  • Specify the description of the service that is displayed in the API Catalog. For example, CA DBM for DB2 Tools API Data Service - Production.
  • Specify the hostname of the web server. The API gateway and catalog require this value to correctly redirect traffic. For example,
    service.example.com
    .
  • Indicate whether you use the API Catalog. You
    must
    enable this option (true) to use the API Catalog.
  • Specify the URL for the API Mediation Layer discovery service. For example,
    http://user:[email protected]:10001/eureka/
    . Consult with your system administrator to find out the configuration details of the API Mediation Layer instance running in your environment.
  • Indicate whether to enable Single Sign-on (SSO) support in the API Mediation Layer using PassTickets. For more information about configuring the API Mediation Layer to generate PassTickets for an API Service, see Enabling PassTicket creation for API Services that Accept PassTickets in the Zowe docs.
  • Specify the CA Common Services for z/OS (CCS) ESM Microservice application name (APPLID) to enable Single Sign-on (SSO) support. This value is required when enabling SSO. For more information, see (Optional) Configure PassTicket Functionality in the CA Common Services documentation.
    The Zowe started task user ID must have permission to generate PassTickets for users of this API service.
After configuration of the DBM Data Service is complete, enable the HTTPS connection between the API Mediation Layer and the DBM Data Service.
You must import the public certificate of the Certificate Authority (CA) that signed the service certificate into the
API Mediation Layer trustStore
. For more information about the DBM Data Service HTTPS configuration, see Address DBM Data Service Security Requirements. For more information about the API Mediation Layer HTTPS configuration, see Import an API Service Certificate in the CA Brightside documentation.
Discovery of the API Mediation Layer servers does not work with SSL enabled.
Verify the Startup Configuration
After the configuration has been updated, the systems programmer verifies that the installation was successful.
Follow these steps:
  1. Restart the DBM Data Service.
  2. Verify that you have successfully integrated the CA Database Management Solutions for DB2 for z/OS REST APIs:
    1. Go to the API Catalog home page.
    2. Wait for the CA DBM Db2 Data Service API tile to appear. The tile can take up to a minute to appear.
    3. Open the tile. If the list of available API endpoints appears, the REST API is successfully integrated with the API Mediation Layer. Otherwise, review the integration steps.
    4. Access the API endpoints to validate that routing through the API Mediation Layer works as expected.
You can now access the product-specific REST API services through the API Mediation Layer. This integration makes your service details such as availability status and API documentation available through the API Catalog, enables you to run multiple service instances to ensure high-availability, and lets you change the service IP location without affecting the REST API client communication.