Getting Started

Eager to start using the API? Great! Before you begin, its important you understand how security works and the overall concepts of the API.

Security

In order to make calls to the API, You needs to know:

  1. Your company credentials to determine the data you're licensed to use.
  2. Your developer credentials for analytics and call rate packages.

Tell us what company you work for and who you are, you'll need to include two strings in the request headers for every call you make.

Name Type Value
Authorization String

JSON Web Token (JWT) obtained from JATO's OAuth 2.0 service. To retrieve your token for the Authorization header, you'll need to send a POST request to https://apidemo.jato.com/authorize/oauth/token with the following body:

Key Value
username Your assigned JATO Azure Active Directory email.
password Your assigned JATO Azure Active Directory password.
grant_type password

Be sure to use the 'application/json' body format type when posting these values to the endpoint.

                {
                  "username" : "xxxxx.xxxxx@jato.com",
                  "password" : "xxxxxxxx",
                  "grant_type" : "password"
                }
            

Once posted, the response follows the OAuth 2.0 format which is:

                {
                   "access_token": "string",
                   "token_type": "bearer",
                   "expires_in": int, //lifespan of token in seconds
                }
            

The value you need to supply for Authorization is {token_type} + ' ' + {access_token}

For example: "bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1Ni..."

Subscription-Key String The primary subscription key found in your developer profile.

Using The Docs

Now that you have the concepts down, its time to check out our interactive API docs where you can browse all the available calls and even try them out right from the documentation!

  1. Navigate to the API Documentation.
  2. Select a specific API.
  3. Select an individual call in the left column that you wish to explore.
  4. To test the call, click the 'Try it' button to launch the console.
  5. Select a culture you have access to and fill in other parameters as needed.
  6. Under Authorization and next to JATO, select 'Client Credentials' from the drop down menu.
  7. Click the 'Authorize' button when prompted to retrieve a valid OAuth 2.0 token.
  8. Click the 'Send' button at the bottom to exectute the call and view the response.