Get an Access Token¶

Last updated: March 2, 2022

Overview¶

The ARD API requires an OAuth access token to authenticate requests. To request a token, send your account credentials to the /authenticate endpoint.

Request example¶

Root url

https://ard.maxar.com/api/v1

POST /auth/authenticate

Request Body

{
    "grant_type": "password",
    "username": "{{username}}",
    "password": "{{password}}"
}

The grant type will always be "password" for a GetToken request. Your username is the email address used to set up your ARD account.

Forgot your password? Enter your email address into the ARD password reset form.

If you don't have a Maxar ARD subscription, contact a Maxar Sales Representative to learn more.

Response example¶

{
    "access_token": "{access token}",
    "token_type": "Bearer",
    "expires_in": 43200,
    "refresh_token": "{refresh token}"
}

Get a token using "refresh token"¶

The Response to the GetToken request includes a "refresh token". This token allows you to request a new token without entering your username and password. Use the "refresh token" value from the GetToken response to make this request.

{
    "grant_type": "refresh_token",
    "refresh_token": "[the refresh token from your GetToken api response]"
}

For this request, the "grant type" is "refresh_token."

Using your token¶

API users: A token is valid for twelve hours. Once a token expires, you'll need to request a new one.

SDK users: if you set up your .ini files to use your ARD credentials, you can skip this step. A new token will be fetched for you each time you run the SDK.

Application Developers: The response from a GET token request includes refresh token credentials.

The Postman collection is set up so that the token will be added to the environment variables when the request is made. This means you can request the token and then immediately make "select" or "order requests". However, it is possible that your Postman configuration will prevent this. Check your environment variables to see if the token appears. If not, you can copy it from the response and add it manually.