Purpose: The purpose of this endpoint is to identify a company, either by using an API Key or an access token.
As mentioned, there are two ways in which you can identify a company:
- API Key
- Access Token
Below are steps for both the methods:
Generate an API Key
- Log in to the Motive Dashboard using your credentials.
- At the bottom of the menu, click the admin icon (first icon).
The admin view appears. - Scroll down to locate and select the Developers option.
- On the Developers page, click +Request API Key.
A pop-up appears. - Provide a name for the API key OR you may directly click Save.
You have now successfully generated an API key for yourself. Repeat the steps if you want to generate another API Key. Motive allows you to generate multiple API keys for multiple applications.
The Developers page will display all the API keys that you generate for your organisation.
Endpoint Header
Use the above generated API key as a header for v1/companies endpoint. Ensure to mention the key as X-API-Key and the value as
When you call the endpoint with API key as a header, in the response you must see the details of the company it represents.
Generate an access token
PREREQUISITES
You must meet the following requirements for generating an access token:
- Create a developer account
- Create an application
- Create a fleet in Motive
After Motive associates your application to the master fleet, you must generate an access token for your company.
Take the following steps:
Step 1: Trigger the initial OAuth call
- Log in to your fleet on the Motive platform.
- Paste the following link. Ensure to add your own parameters for the variables.
- https://gomotive.com/oauth/authorize?client_id=<YOUR_CLIENT_ID>&redirect_uri=<YOUR_RE
DIRECT_URI>&response_type=<code>&scope=<scopes>
- https://gomotive.com/oauth/authorize?client_id=<YOUR_CLIENT_ID>&redirect_uri=<YOUR_RE
Variable | Description |
---|---|
client_id | Enter your client_id that is generated by Motive. |
redirect_uri | Enter the redirect URI that you enter when creating your company. |
response_type | Enter the code of the response type. |
scope | Specify your scopes as required. |
The platform will redirect you to the corresponding URL, and prompt you to install the app.
- Click Install.
You will be redirected to the provided URI. The Motive platform will also generate an authorization code and append the same to the URL. - Make a note of the authorization code that is captured by your listener.
Step 2: Generate an access token
- Call the following endpoint:
-
Ensure to add the following variables:curl -X POST 'https://keeptruckin.com/oauth/token' -d 'grant_type=authorization_code&code=<AUTH_CODE>&redirect_uri=<REDIRECT_URI>&client_id= <CLIENT_ID>&client_secret=<CLIENT_SECRET>’
Variables | Description |
---|---|
grant_type | Mention the grant type as "authorization_code". |
code | Specify the authroization code that is generated by Motive and capture by your listener. |
redirect_uri | Specify the redirect_uri that you mention during the creation of your application. |
client_id | Specify your client_id |
client_secret | Specify your client_secret |
After you make the POST call, you will receive from the platform with the following info:
{
"access_token": "YOUR ACCESS TOKEN",
"token_type": "Bearer",
"expires_in": 7200,
"refresh_token": "YOUR REFRESH TOKEN"
}
Now you have successfully generated your access token.
curl -X POST 'https://keeptruckin.com/oauth/token' -d
'grant_type=refresh_token&refresh_token=YOUR_REFRESH_TOKEN_HERE&redirect_uri=RE
DIRECT_URI&client_id=CLIENT_ID&client_secret=CLIENT_SECRET’
Variables | Description |
---|---|
grant_type | Specify the grant type as refresh_token. |
refresh_token | Enter the refresh token to generate a new access token, |
redirect_uri | Specify the redirect_uri that you mention during the creation of your application. |
client_id | Specify your client ID. |
client_secret | Specify the client secret. |
After you generate your access token, you can now use it to confirm the identity of a company.
Endpoint Header
Mention the access token in the header of the v1/companies endpoint as a Bearer Token in the headers section.