Tweakwise's backend API is an HTTP-based service which allows you to manage your instance programmatically. The functionality ranges from adding products and categories to setting up the Google Analytics 4 module. Basically everything that isn't directly related to your storefront (via the frontend API), is part of the backend API.

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. You're expected to use PascalCasing for the keys of the JSON-encoded body. As you'd expect, the responses of the backend API also use PascalCasing for the keys.

The majority of endpoints require an API client to authenticate itself with each request. Next you'll learn how authentication works for the backend API.

Read more about authentication →