This guide describes the API key authentication schemes available for accessing the platform APIs.
Eleos API Key
To authenticate, include an Authorization header in the HTTP request. Specify the authentication type Key, followed by the value key=API_KEY. Replace API_KEY with the active key from App Manager.
Example:
Authorization: Key key=API_KEY
The following table defines the required configuration parameters:
Property | Value |
|---|---|
Security Scheme Type | API Key |
Header Parameter Name | Authorization |
NOTE: Create and manage API keys using App Manager under App Configuration > Service Config.
Drive Axle
If you are a Drive Axle Hub customer and need to make API calls, or are configuring your document download script, use this authentication scheme.
If you are making calls directly to the API, include the Authorization header with the value DriveAxleKey key=DRIVEAXLE_API_KEY where DRIVEAXLE_API_KEY is your API key.
Example:
Authorization: DriveAxleKey key=DRIVEAXLE_API_KEY
If you are using our open-source Powershell document download script, it will handle setting the header automatically, and you only need to configure it with your API key.
The following table defines the required configuration parameters:
Property | Value |
|---|---|
Security Scheme Type | API Key |
Header Parameter Name | Authorization |
You can view your current API key under the profile area of the Drive Axle Hub.
IMPORTANT: API access is only available with the Platinum plan.