Downloads

The two files below describe the same API — one for tools that read OpenAPI, the other for Postman.

File	API version	Fetched from the API on
Machine-readable description (OpenAPI)	1.0.0	13.09.2026	Download
Request collection (Postman)	1.0.0	13.09.2026	Download

What this means for your integration

Both files are published by the API itself — openapi.json is the description the server gives, and the Postman collection is built from that same description. So what you download always describes the API as it is at the moment of the download, not what was documented at some point.

In practice, three things follow from that for you:

• Do not patch the file you downloaded. If something in it looks wrong, the fix comes from our side and arrives with the next download. Fixed in your own copy, it stays only there — and quietly drifts away from what the server actually accepts.
• Download again when you see a change in the Changelog. That is the moment your copy falls behind, and the only one where you know it in advance.
• Your own values do not go into the file. The key and the address are entered in Postman as variables (see below), so a fresh download does not erase anything of yours.

Postman

After loading the collection into Postman:

1. Enter the key into the apiKey variable — in the collection’s Variables tab, the “CURRENT VALUE” field. The <YOUR KEY> placeholder is not a working value.
2. Call the connection check — send the /api/integration/v1/ping request from the collection. A successful answer with keyValid: true means the key was accepted, before any document is sent.
3. Do not change a single address or header. The collection already carries the right addresses and headers (X-Api-Key, X-Software-Id) for every call; changing them separates it from the description it was generated from.