Authentication for Cloud and Proxy APIs

The Cloud and Proxy APIs require authentication to ensure that only authorized users can access the services.

• Cloud API: Email and password OR API key
• Proxy API: Basic authentication header OR API key

All non-API key methods required users or integrators to know a licensed organization's cloud credentials, so Cargo Spectre recommends that users generate API keys and distribute those API keys to API users for authentication.

API Key Info

When you generate an API key, you will be prompted for a description as well as an optional expiration date for the key.

Consult with your organization to determine the best expiration date for your API key. If you do not set an expiration date, the key will not expire.

To generate your own API key, please visit the Spectre Dimensioner API Key page.

API Key Permissions

Only organization admins can generate API keys. If you are not an admin, you will not see the API key generation page.

Below is a list of all permitted authentication methods for the cloud and proxy APIs, in order of recommendation.

Authentication Methods

Proxy APIs

Header - Bearer Token

Sample Request Header

Authorization: Bearer YOUR_API_KEY

Header - Basic Authentication

Sample Request Header

Authorization: Basic BASE64_ENCODED_CREDENTIALS

The Authorization header is constructed by converting an email and password, e.g. dockManager@fakeLogistics.com:yourPasswordHere to base 64.

You can encode your own here.

Cloud APIs

API Key

There are a few different places that the Cloud looks in to find the API key.

Header - Bearer Token

Sample Request Header

Authorization: Bearer YOUR_API_KEY

Header - Login Key

Sample Request Header

LoginKey: YOUR_API_KEY

Body - Login Key

Sample Request Body

{
    "LoginKey": "YOUR_API_KEY",
    "SomeOtherField": "SomeValue"
}

Email and Password

Sample Request Body

{
    "Email": "dockManager@fakeLogistics.com",
    "Password": "yourPasswordHere",
    "SomeOtherField": "SomeValue"
}