0. Install Postman if you haven't already
1. Download the generated collection here ✨
2. Import the collection into Postman
3. Setup a Postman environment for both Sandbox + Production (learn more):
   • Sandbox:
     • Download the template sandbox environment here
     • Import environment into Postman
     • Set secretKey to your Terminal Sandbox Secret key
   • Production:
     • Download the template production environment here
     • Import environment into Postman
     • Set secretKey to your Terminal Production Secret key
4. Select the environment you want to use in the top right corner of Postman
5. Make requests!

Here's a video that shows you how you can get started with Terminal

Creating Your First Connection with Terminal - Watch Video

This collection uses the following variables to make it easy to chain requests together:

• baseUrl
• secretKey
• connectionToken
• vehicleId
• driverId
• syncId

Note: You can set these variables in your environment or collection. Some will be set automatically for you based on the response of previous requests.

Terminal uses connection tokens to authenticate requests targeting a specific connection. Please set a connectionToken variable in your environment variables if you'd like to act on a specific connection. You can retrieve connection tokens in the dashboard or by calling GET /connections.

Note: When calling POST /public-token/exchange the connection token is set automatically for you upon successful exchange.

Setup the project if you haven't already:

git clone [email protected]:terminal-api/postman.git
npm install

Generate the collection using the following command:

npm run generate