--- title: Adding PingIntelligence ASE APIs description: Add a primary and secondary ASE node to the Akana API Gateway. component: pingintelligence version: 5.2 page_id: pingintelligence:pingintelligence_integrations:pingintelligence_akana_add_api canonical_url: https://docs.pingidentity.com/pingintelligence/5.2/pingintelligence_integrations/pingintelligence_akana_add_api.html revdate: April 3, 2024 section_ids: before-you-begin: Before you begin about-this-task: About this task steps: Steps --- # Adding PingIntelligence ASE APIs Add a primary and secondary ASE node to the Akana API Gateway. ## Before you begin You must: * Install and configure the PingIntelligence software. For more information, refer to [Automated deployment](../installing_pingintelligence_for_apis/pingintelligence_automated_deployment.html) or [Manual deployment](../installing_pingintelligence_for_apis/pingintelligence_manual_deployment.html). * Verify that API Security Enforcer (ASE) is in sideband mode by running the following ASE command: ``` /opt/pingidentity/ase/bin/cli.sh status API Security Enforcer status : started mode : sideband http/ws : port 80 https/wss : port 443 firewall : enabled abs : enabled, ssl: enabled abs attack : disabled audit : enabled sideband authentication : disabled ase detected attack : disabled attack list memory : configured 128.00 MB, used 25.60 MB, free 102.40 MB ``` * If ASE is not in sideband mode, then stop ASE and change the mode by editing the `/opt/pingidentity/ase/config/ase.conf` file. Set mode as sideband and start ASE. * For a secure communication between the Akana Gateway and ASE, enable sideband authentication by entering the following ASE command: ``` # ./bin/cli.sh enable_sideband_authentication -u admin –p ``` * Ensure SSL is configured in ASE for client side connection using CA-signed certificate.Please refer to [Configuring SSL for external APIs](../pingintelligence_reference_guide/pingintelligence_confguring_ssl_external_apis.html) for more details. * Generate sideband authentication token by entering the following command in the ASE command-line interface (CLI): ``` # ./bin/cli.sh -u admin -p admin create_sideband_token ``` * Enable the connection keepalive between gateway and ASE by navigating to `/opt/pingidentity/ase/config/` and setting the value of `enable_sideband_keepalive` to `true` in the `ase.conf` file. * If ASE is running, stop it before making the change and start ASE after setting the value. For more information on ASE configuration, see [Sideband ASE configuration using the `ase.conf` file](../pingintelligence_reference_guide/pingintelligence_sideband_ase_configuration.html). ## About this task | | | | - | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | The primary and secondary ASE APIs should not be exposed to external API clients. For more details on securing ASE APIs, see [Securing PingIntelligence ASE APIs](pingintelligence_akana_secure_api.html). | To add ASE APIs to the Akana API Gateway: ## Steps 1. Sign on to the **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. Enter the name of the API in the **Name** field. 2. Enter the **Endpoint**: *\*://*\*/ase. 3. Click the toggle to enable **Advanced Options**. 4. Enter the API version in the **Version ID** field. 5. For **Pattern**, select **Proxy**. 6. Select **Implementation**. 7. Select **Deployment Zones**. 4. Click **Save** after entering the details. ![A screenshot of the Add API page in the Akana portal.](../_images/tvl1581658826645.png) 5. Add two resources under **Resources**: one to post request metadata to ASE and another to post response metadata to ASE.To add a resource to the ASE API, open API Designer: 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. ![A screenshot of API Designer.](../_images/dwb1579949414329.png) 6. Add the Request resource to the API: ![A screenshot of the Resources page in API Designer.](../_images/cum1579949559737.png) 1. Click **Add Resource** to open the **Edit Resource** window. 2. Enter `/request` in the **Path** to post request metadata to ASE. 3. For **Verb**, choose `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 optional details like **Description**, **Summary**, and **Tags**. 6. Click **Save**. ![A screenshot of the Edit Resource window.](../_images/bni1579949811722.png) | | | | - | ------------------------------------------------------------------------------------------------------------------------------- | | | A default resource is created when an API is added to Akana API Gateway. This resource can be edited to add the first resource. | 7. To add the Response resource to the API: 1. Click **Add Resource** to open the **Edit Resource** window. 2. Enter `/response` in the **Path** field to post request metadata to ASE. 3. For **Verb**, choose `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 optional details like **Description**, **Summary**, and **Tags**. ![A screenshot of the Edit Resource window.](../_images/pwg1579949959144.png) 8. To add the secondary (backup) ASE node, repeat steps 1- 5.