How to get authorized

Before you can execute an operation of the REST API, you must authorize the administrator account to be used.

Before you begin

The task requires the following:
  • Access to an instance of the eperi sEcure Platform which is up and running.
  • Valid credentials of an existing administrator account.
  • The administrator account used has the required roles and permissions for the desired operations.

About this task

Note: In the following we use the Swagger UI to illustrate the authorization process. Swagger UI is a visual documentation of our REST API and allows you to interact with the API resources. In production operation, you will probably use a different method to access and use the REST API.

Procedure

  1. Launch a web browser and enter the URL for the Swagger UI using the following syntax: https://<GatewayHostname>:<GatewayPort>/swagger-ui/index.html#/.
    Example URL: https://crm.example.com:8443/swagger-ui/index.html#/
  2. Select the Auth section and after that the /api/auth/login (Admin login with credentials) operation.
  3. Click Try it out.


  4. In the Example value textbox replace the placeholders for the password and username with the actual credentials of your admin account.
  5. Click Execute.


  6. Copy & paste the JWT bearer token from the Response header authorization to the clipboard.


  7. Click the Authorize button on the top right side of the web page.


  8. In the Available authorizations pop-up menu, paste the JWT bearer token into the Value field. Then click Authorize.


    If the authorization was successful, Authorized is displayed.

  9. Click Close.

Results

You have successfully completed the authorization process for the eperi sEcure Platform REST API.

What to do next

You may now use the operations of the REST API for which the logged in administrator has the appropriate permissions.