Login

Authorization

The Authorization service contains only one API, which is the Login API, to authenticate a user in the VertoFX platform.

The Login service requires you to send your authorization request using clientId and apiKey.

If you don't know your clientId and apiKey, please refer to Authentication.

Also, you need to make sure that the mode parameter is set to apiKey.

In response to your request, you'll be provided with a token value.

You need to add this token value in the Authorization header using Bearer scheme to access all other endpoints.

Each Login API request generates a new token value which is valid for 60 minutes. Therefore, before generating a new token value it is recommended to use an existing token value until it expires.

Body Params
string
required

A unique 28-digit alpha-numeric identifier assigned to the client generated by the VertoFx portal. To know more, click Authentication.

string
required

The key generated to access the API. To know more, click Authentication.

string
required

Pass the mode as apiKey for us to know the request comes from an API customer.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json