Determine which API you’d like to gain access to. Streamline has the following public APIs
Sync (Vehicles, Users, Organizations, Locations)
Activity (Activities, Breadcrumbs, Inspections, Selected Vehicles, Speed Data)
Message (Sent and Sending)
Send an email to email@example.com - be sure to include the following in your email
The customer account for which you’re requesting access
Which APIs you are requesting access to
A brief explanation as to your use-case or business use of the API. This is to help determine if the API is the best resource for what you’re looking for
Please note that we reserve the right to verify this information with the account administrators of the customer in question.
You will receive an email from our support team that includes more information. This information may include information such as the API base URLs and endpoints you can use.
Generate an API Key
Log into the www.mynavistream.com web portal with a user account that has “Super Administrator” privileges. (If you do not have Super Admin privileges please contact your account administrator for help with the following steps.)
Click “Management and Settings” at the top of the portal
Click “API Keys”
Click “Create a new API Key”
Give your key a name. We suggest a name related to what you’ll be accessing the API for.
Set the permissions to Read/Write (No other options at this time)
Click on “Create Key”
Copy the created API key. This is the only time you will see this key. When it is lost it cannot be recovered, so please keep it secure.
Use a program (such as Postman) to access the API base URL and endpoints. When authenticating your API key, use the Authentication header. For the key value, use your API key with NAV2 in front. Be sure to include a space between NAV2 and the key.
Example: NAV2 1234567890123456:abcd1234-abcd-1234-abcd-123456789012
To do this in Postman for example, you would need to add the following Header in the “Headers” section.
You do not need to touch the Authorization section:
You can now being querying the API for the data contained within.
Modify the base URL to query a specific endpoint. These endpoints will be included in the documentation you receive.
Each API also has a set of parameters that can be included in the request. These parameters are documented in the YAML file. To query the API using a parameter, modify the base URL to include the parameter
preceded by a question mark (?).
You can combine multiple parameters using the ampersand (&) symbol.
API keys currently do not expire.
API keys are non-recoverable. If you lose your key you cannot get it again and you will have to generate a new one.
Keep in mind that currently all keys are Read/Write so please be mindful that it’s possible to delete or modify customer data.
APIs are subject to updates. Check your documentation regularly to see if your APIs or endpoints have changed in any way.