traceone_logo

API_DocumentationTrace One's REST APIs


I. What is an API?
II. Why REST APIs
     1. An open platform
     2. Relevant use cases
       a. Integrate data from your systems
         b. Feed your e-commerce sites
III. Overview of Swagger documentation for our APIs
      1. Methodology
      2. Authentication
      3. Permissions

qms-form-shape

I. What is an API?

An API, for "Application Programming Interface", is a set of definitions and protocols that facilitate the creation and integration of software applications. They allow to use the resources, data or functionalities of a web application from another application.

II. Why REST APIs?

A REST API (also called RESTful API) is an application programming interface that respects the constraints of the REST architecture style and allows interaction with RESTful web services. The REST architecture is an acronym that stands for "Representational State Transfer". REST APIs are increasingly used because they work in the same way as the rest of the web.

1. An open platform

Trace One's REST APIs are the answer to your needs for interoperability, integration and data automation.

They enable you to synchronize your repositories (products, suppliers, brands, etc.) but also to distribute your product information over various exchange channels and much more, and guarantee you reliable and secure access to your data and a single source of data.

They help you improve teamwork, information sharing and the automation of your data-driven processes by systematizing and structuring information exchange.

Trace One solutions are perfectly integrated into the information systems used by our customers. Data synchronization is essential in order to make the most of possible synergies between software and deliver value:

interfaceUniform interface to market standards: In accordance with the REST architecture style, which has now become a standard for ease of use and maintenance, our APIs have a uniform interface adapted to it. This ensures perfect communication between applications from different systems via the standard HTTP protocol. The REST standardization also ensures a perennial integration and stability in time since the updates are versioned to allow to continue to use freely a given version of our APIs, and to migrate towards the new version at the appropriate time.

OPTIMISATION_APIOptimization of operations: Our REST APIs provide a clear separation between the client's information system and the Trace One server to optimize operations. The client only handles the retrieval and display of information (or data) and Trace One focuses on the storage and manipulation of the data for greater efficiency.


SecuriteSecurity and control of data exchanges: Our APIs allow our clients' information to be made available securely way since they are protected by the OAuth2 standard, which is the most appropriate and widespread standard for REST APIs today. This is an authorization delegation standard that allows an application to obtain authorization to access a resource (API) on behalf of a user.


speed-API-TO

Speed and flexibility: In addition to being freely available, our APIs are extremely fast to synchronize and very flexible to adapt to communication with different repositories from different solutions. From authentication to requests, they allow for the agile industrialization of information exchange.


In addition, in a data-intensive business context, with consumers increasingly demanding product information, an acceleration of new market trends and changing regulations, easy and rapid access to your data has become an essential issue.

APIs are a relevant answer to these new needs, as they play a basic role as a connector allowing different systems and complex software to communicate.

By facilitating access to and manipulation of data by users, they can more easily control the traceability and safety of products. Smoother information allows for better communication internally, with partners and service providers, but also with end customers.

2. Relevant use cases

Integrate data from your information systems (ERP, Master Data...) and synchronize your repositories with Trace One tools

Trace One solutions can be easily integrated with your internal repository systems (product references, brands, suppliers) to create a data synergy so that the repositories they contain can more easily and automatically feed your databases into our software and vice versa since Trace One can reversibly update your databases.

Feed your e-commerce sites with your labeling information from Trace One

Today, consumers are looking for information about the products they buy. Important information is visible on the e-commerce sites of large retailers to enable customers to make their choice at the time of purchase. More and more applications are appearing to evaluate products based on this information.

The Trace One REST API ensures that labeling information is always up to date on e-commerce sites as products are improved. For private label products, their updates are visible in Trace One solutions.

By providing retail customers with different REST APIs, Trace One provides easy access to all the information they need to collect and analyze data, so that they can easily compare it with national brands.

To learn more about our APIs, you can now consult the full Swagger documentation available in the next chapter below.

API_Central-1

Centralize usefully

Say goodbye to spreadsheet clutter and make all your product information and other repositories travel in one place.

collaboration_API

Collaborate effectively

Enjoy both better communication by avoiding counterproductive email loops, and increased autonomy by having easy access to all the data you might need to collect.

API_Optimisation-2

Optimize easily

Choose the information you want to travel between your systems and Trace One solutions for optimized data repository import and export capabilities.

Swagger documentation
of our APIs

We have chosen Swagger as an open source medium to provide documentation for our APIs. In this form, the usage of our APIs in JSON format is clear and readable.

If you would like to start using these APIs, please visit the following URL: https://ui-api-catalogs.traceone.com/swagger/index.html 

You can contact your Customer Success Manager who can help you with the rest of the process.

In order to authenticate, you will need to fill in some parameters that you can obtain from your Trace One Customer Success contact.
Here are the parameters we are talking about:
client_id: you can get this information from your Customer Success contact at Trace One.
client_secret: you can get this information from your Trace One customer success contact.
grant_type: client_credentials

Here is an example of how to use oAuth to get a token.
https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/ 
Once you have the token, you need to place it in the authorization header of all requests you make as shown below:
Authorization: Bearer <token>