REST API for your SME software

What an API call looks like

With your API key, you get a token and then call any endpoint using a normal HTTP request. Here using letters as an example, once with curl and once in Python.

# 1. Token holen (client_id + Schlüssel aus den Einstellungen, API-Schlüssel)
TOKEN=$(curl -s -X POST \
  https://auth.printerless.ch/realms/members/protocol/openid-connect/token \
  -d grant_type=client_credentials \
  -d client_id=$CLIENT_ID \
  -d client_secret=$CLIENT_SECRET | jq -r .access_token)

# 2. API-Call mit Bearer-Token (Beispiel: Briefe abrufen)
curl -s https://api.printerless.ch/v2/letters/letter/ \
  -H "Authorization: Bearer $TOKEN"

import requests

# 1. Token holen
token = requests.post(
    "https://auth.printerless.ch/realms/members/protocol/openid-connect/token",
    data={
        "grant_type": "client_credentials",
        "client_id": CLIENT_ID,
        "client_secret": CLIENT_SECRET,
    },
).json()["access_token"]

# 2. Briefe abrufen
letters = requests.get(
    "https://api.printerless.ch/v2/letters/letter/",
    headers={"Authorization": f"Bearer {token}"},
).json()
print(letters["items"])

Export OpenAPI specification

The OpenAPI specification is available at api.printerless.ch/openapi/ and is the machine-readable basis of the Swagger interface. Access requires authentication. If you do not attach a valid token, the interface responds with 401.

// OpenAPI-Spezifikation exportieren (Authentifizierung erforderlich)
const token = await fetch(
  "https://auth.printerless.ch/realms/members/protocol/openid-connect/token",
  {
    method: "POST",
    headers: { "Content-Type": "application/x-www-form-urlencoded" },
    body: new URLSearchParams({
      grant_type: "client_credentials",
      client_id: CLIENT_ID,
      client_secret: CLIENT_SECRET,
    }),
  },
).then(r => r.json()).then(d => d.access_token)

const openapi = await fetch("https://api.printerless.ch/openapi/", {
  headers: { Authorization: `Bearer ${token}` },
}).then(r => r.json())

console.log(openapi) // vollständige OpenAPI-3-Spezifikation

Generate TypeScript client

From the OpenAPI specification, you generate a ready-made TypeScript client using the public openapi-generator-cli. The tool runs independently via npx, without installation and without any dependency on Printerless. The same approach is also available for Python and many other languages. You only swap the generator name, for example python instead of typescript-axios.

# 1. OpenAPI-Spezifikation mit Token herunterladen
curl -s https://api.printerless.ch/openapi/ \
  -H "Authorization: Bearer $TOKEN" > openapi.json

# 2. TypeScript-Client generieren (öffentliches Tool, keine Abhängigkeit zu Printerless)
npx @openapitools/openapi-generator-cli generate \
  -i openapi.json \
  -g typescript-axios \
  -o ./printerless-client