API Authentication & First API Call

Get Your Sandbox Account

Before you begin, make sure to create a test account in the Merchant Portal Test environment.

Authenticating Your API Requests

To authenticate your API requests, include the following header in every request:

X-Auth-Key: your_personal_api_key

You can obtain your personal API key from your sandbox account. Each merchant receives a dedicated X-Auth-Key per webshop and per country, ensuring secure and tailored access to the API.

Test Your Authentication

You can easily verify that your API authentication is working correctly by using the simplest request in the Riverty API — GetVersion.

GetVersion does not require any input parameters (except your API key) and returns the current version of the API. This makes it an ideal starting point for testing your setup. It also serves as a baseline for future requests and introduces the core concepts of the Riverty API.

A successful response will return a 200 OK status code along with the API version in the response body.

These authentication principles apply to all other available API requests as well.