Getting started using techTRACK APIv2 [Information]

Modified on Wed, 22 Jan at 7:25 PM

When interacting with techTRACK via REST Application Programming Interface (API) there are tools, documentation and good practices that will help you do it in the easiest way possible.

These are the sections detailed in this article:

How to get the required API credentials to be able to use the API.
How to use Swagger documentation to learn and test the available API methods.
How to use Postman for testing the API calls

HOW TO GET THE REQUIRED API CREDENTIALS

To be able to use the API, you will need two pair of API keys: the user's and the organization's.

WARNING: API credentials are sensitive and should be handled securely. Avoid sharing or exposing them. All API requests must be authenticated; unauthenticated requests will not be processed.

To get the user's API key:

1. Move your mouse over your username and click on Profile.

2. Copy the user's API key from the Api Key field.

To get the organization's API key:

1. Click Organizations from the left menu under the System section.

2. Use the available filters to find the desired organization.

3. Press Edit for the desired organization.

4. Copy the organization's API key from the Api Key field.

NOTE: The organization's details page, including the organization's API key, is accessible to administrators only.

HOW TO USE SWAGGER DOCUMENTATION

You can review the Swagger documentation at https://v2.techtrack.cloud/swagger.

NOTE: This documentation refers to version 2 of the techTRACK API. If you are using v1, please refer to Getting started using techTRACK API [Information]. We suggest you bookmark this link for frequent consultation.

techTRACK's API methods are categorized in Swagger as follows:

Event: Details how to create and get events.
List: Details how to get list data that can be used in another categories.
Pod: Details how to get Proof of Delivery (PoD) data.
Tracking: Details how to create, get and update tracking numbers.
TrackingIntegration: Details how to create an event in Intelcom format.

You can refer to How to Use Swagger Documentation [Information] to learn more about using Swagger for reference and testing Techdinamics' APIs.

HOW TO USE POSTMAN FOR TESTING

Once you have familiarized yourself with the API, the next step is to test it.

You can refer to How to Use Postman to Test API Calls [Step-by-Step guide] to learn more about using Postman for testing Techdinamics' APIs.