7.2. Request a new API Key.
GET RequestNewAPIKey
Description: Return a new API key
from the server using your
session token. Any existing key will be revoked
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]/RequestNewAPIKey?SessionToken=YOUR_SESSION_TOKEN
- Only one request can be made every 30 minutes. A subscriber can also request a new API key by logging in (using the top menu above) and going to the "My Account" page.
- This endpoint returns a new API key. The previous API key will immediately be invalid. Please make sure that this change will not affect any other systems that use the API key before using this endpoint.
Request Parameters
| Paeameter | Type | Description |
| SessionToken | String | A valid Session Token received from the GetSessionToken endpoint. |
Tip:
- You need to first use the GetSessionToken endpoint to get a valid session token.
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 | The 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 below. |
| 5 | Errors | [Object] | No* | An 'Errors' object as described below. |
A successful API response will return a Result object with the requested payload or an 'Errors' object detailing the issue that caused the request to fail.
Result Object
| Parameter | Type | Mandatory | Description | |
|---|---|---|---|---|
| 1 | APIKey | String | Yes | A new API key assigned by the server. |
Errors Object
| Parameter | Type | Mandatory | Description | |
|---|---|---|---|---|
| 1 | Status | Integer | Yes | HTTP status code. |
| 2 | Detail | String | Yes | Description of the status code above. |
Possible Status codes in the 'Errors' object
| Code | Description |
|---|---|
| 400 | Missing parameter or unknown argument in request. |
| 401 | Invalid or expired session token. |
| 403 | The account assigned to this email address is inactive. |
| 405 | Method [request] not allowed. |
| 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:
https://[server]/RequestNewAPIKey?SessionToken=YOUR_SESSION_TOKEN