The Tweakwise Backend API is a HTTP-based service which allows you to manage your instance programmatically.

The functionality ranges from managing the catalog to setting up the Google Analytics 4 module.

The Backend API will always return JSON-encoded responses. If you have to send data to the backend API for operations that involve methods like POST, PUT or PATCH, then you're also expected to use JSON as encoding for the body you send. Use PascalCasing for the keys of the JSON-encoded body. The responses of the backend API also use PascalCasing for the keys.

Authentication

Requests to the Backend API require authentication. See Authentication to learn how to create and use access tokens.

OpenAPI

You can use our OpenAPI specification to automatically generate client libraries or server stubs in the programming language of your choice. This saves time and ensures consistency when integrating with our public API.

Our OpenAPI 3.0 specifications are publicly available and can be used with any compatible toolchain: