| Tip |
|---|
The Login public API was added in v2022.2 - April 2022 |
| Note |
|---|
A valid user account with ResourceXpress will be required to use this API. |
The Login API allows users to generate an AuthToken, this is then used with all other APIs to securely access available information.
The user's Role will determine which APIs they are granted access to.
Once you have successfully received the AuthToken, store this value for use with other APIs.
Take note of the expiry date, by default, the AuthToken will expire after 30 minutes.
...
Using the API
Request Type
POST
Request URL
https://<rx-server>/api/Public/Login
Headers (required)
| Code Block | ||
|---|---|---|
| ||
{
'X-Requested-With': 'com.resourcexpress.report'
} |
Body (required)
| Code Block | ||
|---|---|---|
| ||
{
'EmailId': '<your-rx-email-address>',
'Password': '<your-rx-password>'
} |
Expected Response
| Code Block | ||
|---|---|---|
| ||
{
"UserId": <your-id>,
"UserName": "<your-name>",
"AuthToken": "9a841c01-****-****-****-4fd27be665c7",
"BeaconUid": null,
"TenantURL": "<your-server-address>",
"ExpiresOn": "2022-04-06T12:52:27.526509+00:00",
"ErrCode": "",
"ErrDesc": "",
"Response": true
} |
Postman Examples
...