Integrating Runscope API Monitoring with CA API Management

CA API Management is an API Management solution that allows you to create, secure, deliver and manage the full lifecycle of APIs and microservices at scale. It includes tools for API creation, management, gateway, security, and analytics.

By connecting CA API Management with Runscope, you can import any API or microservices endpoints from your CA API Gateway in seconds and start monitoring your systems, collecting API data, and transforming them into actionable insights.

The CA API Management integration requires a qualifying plan. Contact Sales to get started.


Requirements


Installing the API Test Toolkit for CA API Gateway

The first step in our integration is to install the API Test Toolkit for the CA API Gateway. You can download the toolkit (.sskar) file here.

Next, log in to your Policy Manager and navigate to Tasks -> Extensions and Add-Ons -> Manage Solution Kits:

CA API Gateway showing the Policy Manager navigation menu

Click Install in the Manage Solution Kit dialog:

CA API Gateway showing the Manage Solution Kit dialog option

Select the API Test Toolkit .sskar file and click Next:

CA API Gateway with the windows for selecting a .sskar file

Follow the next steps in the wizard:

CA API Gateway solution kit installation wizard overview of step 2

CA API Gateway solution kit installation wizard overview of the final step

And you’re all set! Now onto the Runscope part.

Importing API Management Endpoints into Runscope

In your Runscope account, go to a bucket's dashboard and select Import Test at the bottom:

Runscope bucket dashboard view highlighting the Import Test button at the bottom of the page

Select CA API Gateway from the list and click on Connect API Gateway Account:

Runscope import view with the CA API Gateway option selected and highlighting the button to continue the import process

Connecting Your CA API Gateway Account

Fill in the fields with your CA API Gateway URL, username and password, and select Connect Account:

Runscope CA API Gateway connection page, showing the fields necessary for the integration: CA API Gateway URL, username, and password

Selecting Endpoints/Folders

After successfully connecting to your CA API Gateway URL, you should see a list of all available folders and endpoints.

You can select a folder to import all endpoints inside it, or expand each folder to select individual endpoints. After you finish selecting the folders/endpoints you want to import, select Import Selected Tests:

Runscope CA API Gateway import, showing the folder/endpoint selector screen, with multiple folders selected

If the import was successful, you should see a list of all the tests that were created inside of Runscope:

Runscope CA API Gateway import success page, showing the same folders that were selected in the previous image as succesfully imported, and linking to their Runscope tests

The tests follow the same naming convention as the CA API Gateway folders. Folders that contain more than 50 endpoints are split into multiple tests (for example, AuthorizationServer has 120 endpoints, it'll be split into AuthorizationServer 1 and 2 with 50 endpoints each, and AuthorizationServer 3 with the remaining 20 endpoints).

Clicking on one of the test on the list will take you directly to that test's editor screen:

Runscope test editor, highlighting one of the tests imported from the previous steps

And you're all set! The next steps would be to create additional assertions for each test to validate their data, and set them on a schedule. Click here for more information on next steps.


Having trouble configuring the CA API Management integration? Contact our support team.