7.3. Request a new API key via email
GET RequestAPIKey
Description: Request a new API key be sent to your registered email address. The API key is emailed to the email address parameter (if valid).
API Usage: This endpoint uses zero API calls. Please refer to section 8.2 for more details on API rate limits.
GET Sample Request:
GET https://[server]/RequestAPIKey?Email=myemail@mydomain.com
- You must use the email address registered with your account.
- An email message with the new API key will be sent if the email address is registered. Delete the email as soon as possible.
- For security reasons, You can only call this endpoint once every 3 minutes.
- You can also change your API key by using the “My Account” feature in the web portal.
| Parameter | Type | Description |
| String | The email address that is registered to your account. |
Response Parameters
| Parameter | Type | Mandatory | Description | |
|---|---|---|---|---|
| 1 | ServerDateTime | String | Yes | The server UTC date and time as an ISO 8601 string. |
| 2 | TimeStamp | Float | Yes | Server date and time as a Julian date. |
| 3 | ExecutionTime | Float | Yes | The number of milliseconds taken to process the request. |
| 4 | Result | [Object] | No* | A Result object as described in table below. |
| 5 | Errors | [Object] | No* | An 'Errors' object as described in table below. |
A successful API response will return a Result object with the requested payload or an 'Errors' object detailing the issue that caused the error.
Result Object
| Parameter | Type | Description | |
|---|---|---|---|
| 1 | Status | Integer | HTTP status code. 200 for success |
| 2 | Detail | String | Description of the status code above. |
Errors Object
| Parameter | Type | Description | |
|---|---|---|---|
| 1 | Status | Integer | HTTP status code. |
| 2 | Detail | String | Description of the status code above. |
Possible Status codes in the 'Errors' object
| Code | Description |
|---|---|
| 400 | Missing parameter or unknown argument in request. |
| 403 | The account assigned to this email address is inactive. |
| 405 | Method [request] not allowed. |
| 429 |
Requested too many
times. You may retry in
3 minutes”
|
| 500 | Server may be down for maintenance. |
This is not an exhaustive list and additional error codes may be returned. The Errors object Detail field will return request specific error information.
Possible HTTP response codes
This endpoint returns 200 for
success.
You can get HTTP client network errors or server
errors from any API request. You should check
with your network or IT colleagues in case the issue is
a
local one.
All server generated errors will return an
'Errors'
object that will give specific details about the error.
A full list of HTTP codes and their meanings is
available here,
Success and fail examples
Sample Request:
GET https://[server]/GetAccountDetails?SessionToken=YOUR_SESSION_TOKEN