Getting started using techOMS API [Information]

When interacting with techOMS via 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 Swagger for testing the API calls

HOW TO GET THE REQUIRED API CREDENTIALS

To be able to interact with the API, you will need your techOMS Vendor or Warehouse API Key.

Each Vendor or Warehouse has its own key, you will need a different set of keys for each one.

Reach your Techdinamics POC(s) requesting the key(s) and detailing for which Vendor(s) or Warehouse(s) you need them, and these will be sent to you via a secure link (1Password).

HOW TO USE SWAGGER DOCUMENTATION

You can review the Swagger documentation at https://techoms.io/swagger.

NOTE: We suggest you bookmark this link for frequent consultation.

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

• Authorize: Details the Authentication methods

• Inbound Orders: Details who to get, create and cancel Inbound Orders

• Inventory Levels: Details how to get, delete and set Inventory Levels

• Orders: Details how to get, create, cancel and fulfill Orders
• Products: Details how to get, update create and check Products
• Product Variants: Details how to get and create Product Variants
• Receipts: Details how to get, update and cancel Receipts
• Shipments: Details how to get, fulfill and cancel Shipments
• Models: Details the available objects

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 SWAGGER FOR TESTING

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

This section details how to use the Try It Out module to test a few interactions.

Based on the requirements provided, your assigned Integrator can provide you with a request body based on your project's particular needs.

Otherwise, if you try a method that doesn't require so, you can directly use the module.

AUTHENTICATE IN TEST MODE

Before interacting with the API to post your request, verify your Credentials are ready to be used.

To do so:

1) Press Authorize to begin the Swagger authentication process

2) Enter your techOMS API Key as provided by the Integrator

3) Press Authorize

NOTE: This particular step is provided for testing purposes. To authenticate in production mode, the basic authentication, where you'll need to use your Credentials, has to be completed as a part of the method header.

CREATE AND EXECUTE THE REQUEST

Use the Try It Out section with the payload you created or which was provided by the Integrator. 

Note to:

1) Complete the Parameters/Body accordingly

2) Select the Parameter Content Type according to the type of requestBody you will use

3) Press Execute to send the request

4) Review the response result