Integrating with Trax
There are several frequently used terms in this documentation, they are:
Item - Recognizable objects like SKUs and POS materials
Scene - A set of one or more images that can be stitched together
Questionnaire - A set of questions asked during store visit
Session - A store visit; may be compromised of scenes and images and/or questionnaires
Supported File Formats and Standards
All of the messages are sent in the JSON format. The JSON format is text only, it can easily be sent to and from a server, and can be used as a data format by any programming language.
For more information: https://en.wikipeida.org/wiki/JSON
CSV (Comma Separated Values) format messages are supported in several API Routes
For more information: https://en.wikipedia.org/wiki/Comma-separated_values
Images may be sent to Trax as part of the Store Visit Inflow/Input API. The images sent must follow the following specifications:
Image Type: Trax's system supports the JPEG image type
Image Size: The maximum supported image size is 5 MB
Character encoding UTF-8
Encoding is UTF-8 based
UNIX Epoch Time Timestamp
The datetime/timestamp requested and provided by the Trax API is the Unix Epoch time format
For more information: https://en.wikipedia.org/wiki/Unix_time
UUID- Version 4
A universally unique identifier (UUID) is a 128-bit number used for identification. Trax supports Version 4
For more information: https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_.28random.29
Services and Protocols
RESTful Services over HTTPS
REST is primarily used to build Web services that are lightweight, maintainable and scaleable. A service based on REST is called a RESTful service.
For more information: https://en.wikipedia.org/wiki/Representational_state_transfer
Asynchronous Jobs over HTTPS
Asynchronous jobs provide a solution for communicating data for requests that may require a response time that is larger than the standard HTTP response time. This is usually a result of updating a large amount of entities where the update time is not required to be synchronous with the request.
Links to Storage Location
In several occasions a link will be provided to a storage location for downloading an image or a report.