---
title: Preparing to deploy the CA API gateway integration
description: Confirm that the following prerequisites are met before deploying the PingIntelligence integration.
component: pingintelligence
version: 5.2
page_id: pingintelligence:pingintelligence_integrations:pingintelligence_ca_api_prepare
canonical_url: https://docs.pingidentity.com/pingintelligence/5.2/pingintelligence_integrations/pingintelligence_ca_api_prepare.html
revdate: April 3, 2024
section_ids:
  about-this-task: About this task
  steps: Steps
  result: Result:
  troubleshooting: Troubleshooting:
---

# Preparing to deploy the CA API gateway integration

Confirm that the following prerequisites are met before deploying the PingIntelligence integration.

## About this task

Before deploying the PingIntelligence integration:

## Steps

1. Configure the gateway using CA API Gateway Policy Manager.

   PingIntelligence was developed with and qualified with CA API Gateway 9.4. Contact PingIdentity for other supported releases.

2. Install and configure the PingIntelligence 4.0 or higher software.

   For more information, refer to [PingIntelligence manual deployment](../installing_pingintelligence_for_apis/pingintelligence_manual_deployment.html) or [PingIntelligence automated deployment for virtual machines and servers](../installing_pingintelligence_for_apis/pingintelligence_automated_deployment.html).

3. Install Java on the system from where the bundle is imported into the CA API Gateway.

4. Verify that ASE is operating in `sideband` mode by running the following command in the ASE command line:

   ```
   /opt/pingidentity/ase/bin/cli.sh status
   ```

   ### Result:

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

   ### Troubleshooting:

   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.

5. For a secure communication between CA and ASE, enable sideband authentication by entering the following command in the ASE command line:

   ```
   # ./bin/cli.sh enable_sideband_authentication -u admin –p
   ```

6. To generate the token in ASE, enter the following command in the ASE command line. Save the generated authentication token for further use.

   A token is required for CA to authenticate with ASE. This token is generated in ASE and configured in the policy Extensible Markup Language (XML) *(tooltip: \<div class="paragraph">
   \<p>A structured, hierarchical text format, based on SGML, for the flexible and organized exchange of data.\</p>
   \</div>)* file.

   ```
   # ./bin/cli.sh -u admin -p admin create_sideband_token
   ```