API clients

Beliq publishes a live OpenAPI 3.0.3 document at https://api.beliq.eu/openapi.json. Import it into Postman, Bruno, Insomnia, Yaak or Hoppscotch, or open the public Postman workspace.

Beliq serves its own OpenAPI document at https://api.beliq.eu/openapi.json. It is public, needs no API key, and costs no quota. The file is generated from the route schemas the running server uses, so it cannot drift from the API it describes.

Every general-purpose API client reads OpenAPI natively, so there is no Beliq-specific collection to download and keep in step. Point your client at that URL.

The public workspace is ready to use. It holds the collection and an environment with an apiKey field waiting for your key.

That forks the collection into your own workspace. You can also browse it first at postman.com/beliq-eu/beliq-api.

After forking, select the Add your API key environment and paste your key into apiKey. The collection already sends it as the X-API-Key header on every request, and baseUrl is already set to https://api.beliq.eu.

All four import an OpenAPI document directly, either from a URL or from a saved file:

curl -O https://api.beliq.eu/openapi.json

• Bruno: Collection menu, then Import, then OpenAPI V3 Spec.
• Insomnia: Create, then Import From, then URL.
• Yaak: Import, then pick the file.
• Hoppscotch: Collections, then Import/Export, then Import from OpenAPI.

None of them has a public directory to list an API in, so the spec URL is the whole integration.

The spec declares two schemes and the API accepts either, so an importer may wire up whichever it prefers:

• X-API-Key: <your key> as a header.
• Authorization: Bearer <your key>.

Both are described on the Authentication page. Use a test-mode key while you are exploring: a test key runs the same engine, the same rulesets and the same validation as a live key, and never counts against your monthly quota. Its output is stamped as a sandbox specimen, so do not be surprised by the marker in a generated document.