Content Comparison

This page will guide you through the usage of our API and help you get started quickly.
You will learn how to integrate and use the AGILITY API to analyze network traces with ease.
Please ensure that you have the necessary credentials and permissions to access this API.

Overview

The AGILITY API is APIs are designed for system integrators and developers. Its primary function is to enable advanced analysis on network traces, specializing in root cause analysis for call flows within these traces. The API supports file formats such as .PCAP, .PCAPNG, .CAP, and .ZIP.

...

The base URL for accessing the API is: OpenAPI documentation is: http(s)://<YOUR_PUBLIC_DN>/cv/api/public/docs (i.e https://cv-dev.b-yond.com/cv/api/public/docs )

Authentication

To interact with the AGILITY API, you must first authenticate to get an id_token.

...

Use the value of YOUR_ID_TOKEN in your subsequent API requests as a Bearer Token to authenticate your actions.

Use the REFRESH_TOKEN_VALUE to obtain de new token as described in the next section.

In the example above, token expires in 300 second (5 min) while the refresh_token is valid for 1800 second (30 min).

Note: Always keep your id_token, access_token, and refresh_token secure. Do not expose them in client-side scripts or other insecure locations.

Handling expired tokens

When an access token expires, AGILITY API will no longer accept incoming request and will redirect you to login page. To handle this situation, we recommand you to always request a new id_token using the refresh token if it still valid or just re-authenticate.

To refresh an expired token, follow these steps:

1. Make a token refresh request: Send a POST request to the token URL with the required parameters to refresh the token. Use the refresh token received during the initial authentication.

   Example Request:

   Code Block
   language bash
   POST /cv/auth/realms/agility/protocol/openid-connect/token Content-Type: application/x-www-form-urlencoded grant_type=refresh_token &refresh_token=[Your Refresh Token] &client_id=d0d8b0d806f9

2. Receive a new Id_token: If the refresh token is valid, AGILITY will respond with a new access token and potentially a new refresh token.

   Example Response:

   Code Block
   language bash
   HTTP/1.1 200 OK Content-Type: application/json { "access_token": "[New Access Token]", "expires_in": 300, "token_type": "Bearer", "refresh_token": "[New Refresh Token]", "refresh_expires_in": 1800, "id_token": "[New Id Token]", // ... other token information }

3. Update your authorization: Use the new access token in your request headers for subsequent API requests.

By following these steps, you can seamlessly handle expired tokens and ensure continuous access to AGILITY APIs without requiring users to re-authenticate.

Remember to securely store and manage the refresh token, as it provides long-term access to the API on your behalf and should be protected from unauthorized access.

Endpoints

1. Retrieving Supported Services

...