Get Started with Provider Connectivity Assurance APIs

Getting Started

Use Postman (or a similar tool) to work with the APIs. Postman is recommended because it:

• Shares APIs across teams with workspaces.
• Supports environment variables to switch quickly between tenants or Provider Connectivity Assurance analytics instances.
• Supports OpenAPI, which simplifies importing specifications.

For a REST refresher, see the REST tutorial.
For more information and API examples, see Querying Session PM Data via API.

Step 1: Download Postman

• Go to https://www.postman.com/downloads/ and install Postman on your computer.

Step 2: Import Provider Connectivity Assurance Analytics API Specifications

1. Go to http://api.accedian.io and download the OpenAPI specification.
   

2. Start Postman and import the swagger.json file.

The collection includes API folders for v1, v2, and v3. Use the newest version unless a required endpoint is unavailable.

Step 3: Set Up Global and Environment Variables

Use global and environment variables to reuse the same requests across environments.

1. Embed variables in URLs or payloads using double curly brackets: {{variable_name}}.
2. Click the environment settings cog in the top-right corner.

3. On the Manage Environments page, select Globals.
4. Add a global parameter named protocol and set it to https.

5. Create a new environment and add a host variable set to your tenant URL.

6. Save and select your environment.

7. Click the Eye icon to view current variable values at any time.

Step 4: Authenticate

Set up a session with Provider Connectivity Assurance by sending a login request. Tokens periodically expire; obtain a new token when needed.

1. In the collection, search for the Login API.

2. Edit the request URL to use {{protocol}} and {{host}}.

   Note: The request body requires {{username}} and {{password}}.

3. (Optional) Add username and password to your environment variables, or enter them directly in the request. If credentials do not vary across environments, variables are not required.

4. Click Send.
5. Verify the response includes:
   • HTTP status code 200 OK.
   • A payload with account details.
   • Authorization and cookie headers.

Examples

Reset a User Password (Admin Only)

Admins can retrieve user IDs and issue a password reset to generate a new onboarding URL.

1. Use Retrieve a list of users known to Skylight AAA.

   

2. Find the user and note the user ID.

3. Use Reset a password for a user provisioned in Skylight AAA, and set {{userid}} in the URL or as a parameter.

   

   

4. Send the request. Copy the onboarding token from the response payload and share it with the user.

Onboarding URL format:

• https://{{host}}/onboarding?token={{onboarding_token}}