Application Program Interface (API)

Owned by Rob Whyte (Unlicensed)
Last updated: May 16, 2023 by Kyle W.
2 min read

The Application Program Interface (API) is the backbone of both switching and the WebUI.

  1. The switching API handles the data refresh and configuration changes from the RM → DB → (LB, TS, TM, MS).

  2. The UI API handles the communications between the WebUI and the RM.

As our API employs REST API Token-based Authentication, the API call /users/sign_in/ generates a session 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 APIs, connect to the API explorer at https://api-customername.peeredge.com

 

Since the Peeredge API employs REST API Token-based Authentication, your first task is to get a Token. The API call /users/sign_in/ generates a session 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 view the token:

  1. Scroll down to Users and expand the Users sub-menu then Users/sign_in.

  2. Click Try it out. The platform displays username and password fields that correspond with a username and password used to log in to your PE3 instance.

  3. Enter the login information and then click Execute. You should find the token string at the beginning of the response.

Note:

  • The user’s login name (email) and the user’s password are displayed in the output.

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