APIs are mechanisms that enable two software components to communicate with each other using a set of definitions and protocols.  We offer two APIs:

1. Webhook APIs provide efficient real-time updates.
2. Traditional REST API for more common queries and programming activities.

An API token (more commonly called a bearer token) is a security token used to authenticate and authorize requests and access to protected resources in web applications and APIs.

The name "bearer authentication" means “give access to the bearer of this token.”  We use it with our API to identify and authorize your access. 

Does my insurance provider give me a discount for my GPS telematics service at Linxup? 

Possibly! It never hurts to ask your provider what they can offer you depending upon the type of devices you have and the data those devices provide. Several company's in today's insurance market do indeed offer discounts when using a telematics service such as Linxup.

What if my insurance company needs to connect to my telematics GPS data?

If you do not have ELD service for your Linxup telematics GPS devices, then all that needed is just a simple API key token you'll need to create and generate via the instructions below.

What if I do not have ELD, but I still need to connect to brokers for shipments or loads?

All that needed is just a simple API key token you'll need to create and generate via the instructions below.

Most software at this time is using our V2 API keys. When generating and using the API key via the directions above, if the API key needs verification, if any webhooks or endpoints are unable to connect or sync, or if you're needing additional assistance with this you may also reach our Linxup Support Department. Also make sure to contact the software you're attempting to connect to Linxup to do additional troubleshooting. 

NOTE: Document every API token you create so you can quickly delete it should it become compromised.

To delete your API token, select the trash bin icon to the right of the token. This is the button to select should your token become compromised.

API tokens are free! Generate as many tokens as you have partners to minimize your risk if one is leaked.

Follow these steps to create/find your V2 API token (most software at this time takes our V2 key):

1. From your portal, select ‘Setup’ from the top toolbar.
2. Select ‘API/Developers’ from the left menu.
3. Select ‘+ Create New Token.’

Follow these steps to find your host link:

1. From the API/Developers page, select the ‘API documentation page’ link.
2. Locate your API host link in the middle of the page.

NOTE: The API token and host link are specific to each account.

NOTE: API V3 is currently in beta. To enable API V3, please contact Support at 877-732-4980.

Standardized objects + field names

• Wherever possible, we reused common objects, so that most messages will only have a handful of unique fields that are tied to their actual purpose. Field names should now also be consistent between different messages.

Retry failed delivery

• If a message fails on its first delivery attempt due to something that could be a temporary network issue, we will reattempt delivery up to three times, with a rolling backoff.

Saving of undeliverable messages

• Messages that can't be delivered for whatever reason are saved locally for several days, and can be resent if needed after the outage has passed. We will hopefully have a formal process for this eventually, but for now, if your system experiences an outage and you would like to have the affected messages resent, please contact the email addresses above.

Increased reliability

• The new system has separated larger clients into their own instances, and rate-limits endpoints that exceed a 50% failure rate until they recover. For most integrations, this should mean a far lower rate of delayed or dropped messages from our side.

Custom data (pending)

• We have the ability to include any custom data that you provide in the messages for most objects - for example, if you would like to add some identifying information for all of your employees in our system, we will include that when those employees appear in messages. The ability to add and maintain this information will be part of our new external API, which is still under development.

NOTE: API V3 is currently in beta. To enable API V3, please contact Support at 877-732-4980.

Yes, you will need to generate a new API token for V3.

To generate a new API key:

1. On the portal, select ‘Setup’ from the top toolbar.
2. Select ‘API/Developers’ from the left menu.
3. Select ‘Experimental’ API Version from the top right corner.
4. Select the orange ‘Create New API Key’ button.

NOTE: API V3 is currently in beta. To enable API V3, please contact Support at 877-732-4980.

To authenticate your V3 API Key:

1. On the portal, select ‘Setup’ from the top toolbar.
2. Select ‘API/Developers’ from the left menu.
3. Copy your API key.
4. Select the ‘document’ link.
   • https://api.linxup.com/pullapi/swagger-ui/index.html
5. Generate a JWT token by selecting the green ‘jwts’ dropdown menu and selecting the ‘Try it out’ button.
   • Paste your API key.
   • Select the ‘Execute’ button.
   • Copy the response body. This is the token you will use to authenticate.
6. Select the green ‘Authorize’ button.
7. Paste the token and select ‘Authorize.’
   • You can now test calls by choosing the call, selecting ‘Try it out’ and ‘Execute.’

First and foremost, please consult and confirm with the other software in question on what information and data that is being sought, what is needed and what is required for an appropriate connection to be made with the Linxup API feature. Any software you're considering connecting to Linxup, please note that every software company may or may not allow a connection to be made to the Linxup open API feature. This determination is made by the other software in question.

If the open API feature can be utilized and accepted, typically, all the other software may need is just a simple API key token you'll need to create and generate via the instructions above.

When generating and using the API key via the directions above, if the API key needs verification, if any webhooks or endpoints are unable to connect or sync, or if you're needing additional assistance with this you may also reach our Linxup Support Department. Also make sure to contact the software you're attempting to connect to Linxup to do additional troubleshooting.

A few steps will need to take place first, but yes!

Ensure that all steps below have been completed in advance before attempting a connection.

• The Linxup GPS account must be activated.
• GPS devices needing connection to the Highway software should be activated via activation code in the Linxup GPS admin portal. Those same GPS devices should be installed and allotted approximately an hour to come online to be seen in the Linxup GPS map section.
• Per the Highway software, ensure the vehicles with GPS devices installed and needing connection to the Highway software match up with the COI information on file with the Highway software.
• For the Highway software to connect properly, check to make sure that any vehicles needed to be seen by Highway have been driven within the past 7 days.
• Make sure the Highway account has been logged into and set up properly at www.Highway.com and follow the steps to verify equipment. Additional equipment verification steps are required by Highway and will be prompted during this process via https://highway.com/onboarding/carrier/equipment 
• After all items have been completed above, review and follow the steps in the pictures below to generate a V2 API key from the Linxup GPS admin portal.

• Generate a V2 API key from the Linxup API section of the admin portal as depicted below. Please note that drivers do not have the ability to do this, just administrators for the Linxup GPS portal.

• Copy the newly created V2 API key into the Highway software prompt field shown below.

• You have a short video where to find and how to create your Linxup API Key. Clicking on the following highlighted link also briefly shows the appropriate steps for completion. > CLICK HERE!
•  NOTE*: Per Highway software, having active, in use, vehicles not accurately listed in the Linxup GPS admin portal and also the Highway software both on insurance policies can trigger red flags due to liability risks.
• Still having trouble after the steps above have been completed? Please call Highway directly at 906-444-4929 with your Linxup V2 API Key ready and a short description of the issue at hand.