Demo Environment

The Retailer API features a demo environment that allows for testing requests from users to validate that their API connection is working. The demo environment is primarily focused on testing implementation compatibility (models, validations, and endpoint mappings).

Features:

  • Authentication (works the same as in production)

  • Hard coded examples for every endpoint

  • Validations and models which are the same as the current production version of the API.

  • Rate limits headers

These features can be used to help you to build a proper implementation of the API or when you want to implement a new endpoint without connecting to production. The demo environment returns hardcoded example messages that only match for a specific request that are described in the demo environment documentation.

The demo environment isn’t representative for load/performance testing or testing rate limits configuration per endpoint as only 1 generic rate limit is configured. It is also not advised to depend on the demo environment in your CI/CD pipeline.

All endpoints are represented in the demo environment, but there is no end-to-end process. For example, updates will return a process status entity, but this is a mocked instance so no actual updates are being processed.