| Excerpt |
|---|
The Login API allows users to generate an AuthToken, this can be used with other APIs to securely access available information. |
| 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. |
| Excerpt |
The Login API allows users to generate an AuthToken, this is then used with all other APIs to securely access available information. |
...
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.
| Expand | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
If you are using ResourceXpress SaaS please contact our support team at helpdesk@qedas.com. If you are using ResourceXpress On-Prem then you will need to modify the “AuthTokenExpiry” value found in the web.config file. On your ResourceXpress server navigate to the RX install location. By default, this is Open the web.configfile in your preferred text editor.  Find the “AuthTokenExpiry” option, under <appSettings>.
Update the value to your desired duration in seconds.
|
...
Using the API
Request Type
...
Headers (required)
| Code Block | ||
|---|---|---|
| ||
{
'"X-Requested-With'": '"com.resourcexpress.report'"
} |
Body (required)
| Code Block | ||
|---|---|---|
| ||
{
'"EmailId'": '"<your-rx-email-address>'",
'"Password'": '"<your-rx-password>'"
} |
...
Example 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
...