The Jay marketplace provides three main interfaces for integration into your application:
- the Playout API for retrieving content,
- the Basket API for managing the shopping experience,
- and the Product API for product management.
This reference contains detailed information about the available endpoints, parameters, and response formats.
All endpoints of the APIs require an X-API-Key in the header. Learn more about how to authenticate your requests in the Authentication Guide.
The Playout and Basket API has a rate limit of requests per minute per API key. Learn more about rate limiting in the Rate Limiting Guide.
All API responses include a standard HTTP status code. In case of an error, the response body will contain a JSON object with details about the error. Learn more about error handling in the Error Handling Guide.
The Playout and Basket API deliver frequently changing data. To ensure optimal performance, we recommend implementing caching strategies on the client side. Learn more about caching in the Caching Guide.
To get access to the Jay API, you need to obtain an API key and Playout ID. This key will be used to authenticate your requests to the API.
See Getting Started with Jay.