Quickstart

​

Overview

​

Instructions

1. Download our Postman collection and import it into Postman.
2. Make a test connection.
   1. Launch Link to create a new connection. Replace {PUBLISHABLE_KEY} with your sandbox publishable key and open the Link URL below.
      https://link.sandbox.withterminal.com/?key={PUBLISHABLE_KEY}&backfill_days=2&redirect_url=https%3A%2F%2Fpostman-echo.com%2Fget
      
   2. Select the Sandbox provider.
   3. Enter any value as the API Key to create a connection.
      Any value works here, since this is a test connection in the sandbox environment and Link doesn’t check the API Key against a real telematics account. Enter invalid or permissions instead if you want to simulate a failed connection. See the Sandbox Environment guide for details.
   4. Wait to be redirected to the redirect_url with a token appended to the URL.
3. Pull the connection’s data.
   1. Copy the public token from the redirected page.
   2. Exchange the public token for a long lived connection token. Call POST /public-token/exchange:
      curl --request POST \
        --url 'https://api.sandbox.withterminal.com/tsp/v1/public-token/exchange' \
        --header 'Authorization: Bearer your_sandbox_secret_key' \
        --header 'Content-Type: application/json' \
        --data '{"publicToken": "your_public_token"}'
      
      Save the token from the response. It’s your connection token, and every request you make for this connection needs it in a Connection-Token header.
   3. Poll until the initial sync completes. Call GET /connections/current and check lastSync.status:
      curl --request GET \
        --url 'https://api.sandbox.withterminal.com/tsp/v1/connections/current' \
        --header 'Authorization: Bearer your_sandbox_secret_key' \
        --header 'Connection-Token: your_connection_token'
      
      Polling works fine for a quickstart, but for production traffic subscribe to sync.completed (and connection.created) webhooks instead so you’re not left waiting on a request.
   4. List the synced vehicles. Call GET /vehicles:
      curl --request GET \
        --url 'https://api.sandbox.withterminal.com/tsp/v1/vehicles' \
        --header 'Authorization: Bearer your_sandbox_secret_key' \
        --header 'Connection-Token: your_connection_token'