Authentication

The API layer of the Automate VX server may be accessed by appending port 4443 to the server IP address and then using the "/api" base URI. A token generated by the server is required for accessing the API layer. This token is authenticated by the Automate VX server when an HTTP request is sent.

NOTE: The Get-Token API call does not require the "/api" URI and is instead accessed at the root base ("/").

To generate a token for accessing the Automate VX server:

  1. Send the Get-Token API call to the Automate VX server with the following method, headers, and parameters:
    • Method: POST
    • Destination: http://[ip address]:4443/get-token
    • Authorization: YWRtaW46MWJleW9uZA==
    • Content-Type: application/json

    2. NOTE: You must encode the username and password (formatted as "username:password") into base64 format for use within the "Authorization" header. A free encoding tool is available at www.base64encode.org.

  2. If the request is successful, a token is returned by the server in JSON format.

Once a token has been generated, the token must be appended to any HTTP request using the "Authorization" header. If the provided token is authorized, the HTTP request is sent to the server. If the token is not authorized, an error message returned indicating that the credentials are not valid.

NOTE: Tokens do not expire but they must be sent from the same IP address. If the server IP address changes, a new token must be generated as described above.