API Documentation

These instructions describe the requirements that external software must meet and how to use the provided QR Module API key correctly to connect to the QR Module REST API.

The external software must:

• Be able to establish HTTPS connections
• Support HTTP requests (GET/POST/PUT/DELETE)
• Be able to send and receive JSON
• Be able to set HTTP headers
• Store the API key securely
• Have access to https://api.qrmodul.ch/v1
• Use the API documentation from QR Module
• Interpret error codes correctly
• Observe rate limits

A more detailed overview of the requirements can be found below the description of the endpoints.

In order for external software to connect to QR Module via the REST API, it must have the following technical capabilities:

Support for HTTPS
All API calls are made via HTTPS.
The software to be connected must:

• be able to establish outgoing HTTPS connections
• support TLS/SSL

Ability to send HTTP requests
The software must support standard HTTP methods:

• GET
• POST
• PUT
• DELETE

JSON processing
The QR Module API uses JSON.
The external software must:

• Be able to send JSON requests
• Be able to process JSON responses

Header handling
The software must be able to set HTTP headers, in particular:

• Authorization: Bearer
• Content-Type: application/json

To ensure secure use of the API key, the external software must:

Store the API key securely
The API key must not:

• be visible in the front end
• be stored in publicly accessible files
• be checked into Git repositories

Recommended:

• Environment variables
• Encrypted configuration files
• Secret management systems

Access restriction
Only authorised systems or servers may use the API key.

The external software must:

• be able to establish outgoing connections to https://api.qrmodul.ch/v1
• ensure that firewalls or proxies do not block this connection
• support DNS resolution of the domain

If you offer IP whitelisting, the software should be able to provide static IP addresses.

For integration to work, the external software must:

Use access to the API documentation
The software must correctly implement the endpoints according to your documentation:

• URL structure
• Parameters
• Request examples
• Response formats
• Error codes

Support authentication method
QR Module uses an API key that is transmitted in the header.
The software must support this method.

Error handling
The software must be able to interpret HTTP status codes, e.g.:

• 200 – Erfolg
• 400 – Ungültige Anfrage
• 401 – Ungültiger oder fehlender API‑Key
• 403 – Keine Berechtigung
• 429 – Rate Limit erreicht
• 500 – Serverfehler

Rate limit handling
If you define limits, the software must:

• Observe Retry-After headers
• Implement backoff strategies