PingIntelligence

Add PingIntelligence ASE APIs

This section explains the steps to add a primary and secondary ASE nodes to Akana API gateway.

The primary and secondary ASE APIs shouldnot be exposed to external API clients. For more details on securing ASE APIs, see Secure PingIntelligence ASE APIs.

To add ASE APIs to Akana API gateway:

  1. Sign on to Akana portal and click Add API from the APIs drop down list.

  2. Select I want to design my API from scratch(REST) only.

  3. Enter the following details for ASE:

    1. Name of the API in Name.

    2. Enter the Endpoint: -<http/https>://<ASE-Hostname or IP>/ase`.

    3. Enable Advanced Options.

    4. Enter API version in Version ID.

    5. Select Pattern Proxy in the Pattern section.

    6. Select anImplementation.

    7. Select Deployment Zones.

  4. Click Save after entering the details.

    tvl1581658826645

  5. Add two resources under Resources, one to post request metadata to ASE and another to post response metadata to ASE.

    1. To add a resource to ASE API, open API Designer by performing below 3 steps.

      1. Navigate to the Overview page of the API.

      2. Choose Details from the left menu pane. The summary of the API is displayed in the details.

      3. In the Design section, click Edit to enter API Designer.

        dwb1579949414329

    2. To add the Request resource to API

      cum1579949559737

      1. Click Add Resource to open theEdit Resource window.

      2. Enter /request in the Path to post request metadata to ASE.

      3. Choose the VerbPOST.

      4. Enter Operation ID. If the user does not provide the value, a random value is generated for Operation ID.

      5. Click Finish after updating the other non mandatory details like Description, Summary, and Tags.

      6. Click Save to reflect the changes.

        bni1579949811722

        A default resource is created when an API is added to Akana API Gateway. This resource can be edited to add the first resource.

    3. To add the Response resource to API

      1. Click Add Resource to open the Edit Resource window.

      2. Enter /response in the Path to post request metadata to ASE.

      3. Choose the Verb POST.

      4. Enter Operation ID. If the user does not provide the value, a random value is generated for Operation ID.

      5. Click Finish after updating the other non mandatory details, such as Description, Summary, and Tags.

      6. Click Save to reflect the changes.

        pwg1579949959144

  6. Repeat steps 1- 5, and add the secondary (backup) ASE node.