Articles in this section

xTrace: Open API Description

Open API is intended for interaction between participants in the goods circulation process (GCP) and the Product Marking Information System, enabling the following operations with marking codes (MC):

  • Register a request for the generation of a list of MCs
  • Retrieve the status of a request for the generation of a list of MCs
  • Obtain the result of processing a request for the generation of a list of MCs
  • Access public information about an MC
  • Retrieve detailed information about an MC

To interact with the Open API on behalf of a GCP, a static API key with the bearerToken type must be generated and used in the Authorization header. The article “Creating an API Key” outlines the requirements and steps for setup.

Key differences compared to the True API:

  • Authorization schema has been updated
  • Request and response handling has been modified
  • The list of returned parameters has been revised

The method public/api/cod/private/codes now returns an extended set of data — it includes most of the values that were previously available via other parameters.

If the required access rights are not granted (e.g., the requester is not the current owner of the specified code), the request to public/api/cod/private/codes will be automatically redirected to public/api/cod/public/codes.

Was this article helpful?
3 out of 7 found this helpful

Comments

0 comments

Please sign in to leave a comment.