API

API

The API (Application Program Interface) is the backbone of both switching and the WebUI.
  1. The switching API handles the data refresh from RM → DB
  2. The UI API handles the data for WebUI → RM.

As our API employs REST API Token-based Authentication, the API call /users/sign_in/ is used to generate a session token using credentials from the UI. You may want to set up an API user specifically for this purpose and for keeping proper logs.

To view the token:
  1. Navigate to your API subdomain provided to you by the support team (*subdomain*/#/Admin/post_admin_sign_in)
  2. Scroll to where it says "users" and then "users/sign_in"
  3. Click "Try it out". This will show a username and password field that corresponds with a username and password used to login to your PE3 instance.
  4. Enter the login information you would prefer to use and then hit execute. You should be able to find the token string in the beginning of the response.