post

/login

Login

Login call initiates the authentication process of the client. It has to be executed prior to making any other API calls.

Required userkey and password parameters are generated by your system administrator through the graphical user interface of the dEngage platform.

Please contact your system administrator for further details.

Request Body

userkey and password parameters are generated by your system administrator through the graphical user interface of the dEngage platform. Please contact your system administrator for further details.

Schema
object
userkey
string

a valid userkey of the api user

required
password
string

a valid password of the api user

required

Responses

Returns JWT access_token. This token must be used in all authorization headers in API calls.

Schema
object
access_token
string

access_token that is valid for expires_in seconds.

This access_token must be passed into the headers of all api calls as Authorization parameter with 'Bearer ’ in front.

Authorization: 'Bearer access_token’

expires_in
integer

access_token expiry period in seconds

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.