Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

The Application Program Interface (API) 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 to keep 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 down to Users and then Users/sign_in.

  3. 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.

  4. Enter the login information and then click Execute. You should be able to find the token string at the beginning of the response.

  • No labels