Application Program Interface (API) Explorer

The Peeredge Orchestrator's REST-based Application Program Interface (API) can be used to manage and configure all functionality provided by the Orchestrator. 

1. The switching API handles the data refresh and configuration changes from the Reporting Manager (RM) → Database server (DB) → (load balancers (LB), traffic switches (TS), traffic managers (TM), media servers (MS)).

2. The Web-based User Interface (WebUI) API handles the communications between the  Web browser and the RM.

The Peeredge orchestrator API employs REST API Token-based Authentication, the API call to /users/post/login  generates a authorization token using credentials from the UI. You may want to set up an API user specifically for this purpose and to keep proper logs.

To explore the Peeredge Orchestrator APIs, connect to the Peeredge Orchestrator's API explorer at  https://api-customername.peeredge.com

Since the Peeredge API employs REST API Token-based Authentication, your first task is to get an Authorization Token.  The API call to /users/post_login generates an authorization token using credentials from the UI. You may want to set up an API user specifically for this purpose to keep proper logs.

To view a user's authorization token for the Subscriber portal:

Click on Subscriber API and scroll down to Users : Users APIs and list the available operations by selecting Show/Hide or List Operations.

A valid username and password will generate a 200 Response Code.  The authorization field will contain the token.

Once you have the Authorization Token, it can be used is to authenticate all the other API requests.