When interacting with techTMS via API there are tools, documentation and good practices that will help you do it in the easiest way possible.
These are the elements detailed in this article:
- Swagger documentation to access API methods
- Receive API keys from Techdinamics
- Postman to Test API calls
Follow the guide and bookmark the documentation as you find it convenient.
The Swagger documentation details the methods, parameters and values you need to interact with techTMS to create, estimate, manifest and delete shipments, as well as getting and sending tracking information.
Access and bookmark the following link: https://techtms.io/api/doc/index.html?url=/api/doc/v2/swagger.json
As you become familiar with the techTMS API, you will have to consult it frequently.
The documentation is divided in the following sections:
Authorize: Details the Authentication methods
Shipments: Details how to interact with Shipments objects
Trackings: Details how to interact with Trackings objects
- Models: Details the available objects
For each method, you will find:
A) Method definition and description
B) Parameters mode
- Example value: Displays an example of how the parameters should be completed
- Model: Displays the object contents, parameters, data types, max/min length and values when applicable
C) Details clarifies values and codes of a parameter whenever applicable
RECEIVE API KEYS FROM TECHDINAMICS
To be able to interact with the API, you will need your techTMS API Keys.
There are two types of keys: Customer and Portal keys, you will need a different set of keys for each one depending on the case.
Reach your Techdinamics POC(s) requesting the key(s) and detailing which one you need, and these will be sent to you via a secure link (1Password).
The API information (API Key) will be used in the next section in the contest of this article to test your connection.
If you use Customer Keys, you should use them as:
- x-account-key = Customer Code
- x-api-key = Customer API Key
If you use Portal Keys, you should use them as
- x-account-key = Portal (the static word)
- x-api-key = Portal API Key
POSTMAN TO TEST API CALLS
Once you have familiarized yourself with the API, the next step is to test it.
This section details how to use Postman to test a few interactions.
To do so, try the following as indicated:
- Get trackings from a Customer using a Customer API Key
CREATE THE CALL
1) Create a new request in Postman
2) Create a Key named x-account-key on the header section with the provided information in the previous section
3) Create a Key named x-api-key on the header section with the provided information in the previous section
4) In Method POST use the URL of the method as indicated by the integrator
5) Execute the generated post file
You will get a response similar to the following: