Riferimento API
Esempio Risposta 200
Esempio Risposta 201 Esempio Risposta 200
Esempio Risposta 200
Esempio Risposta 200
Esempio Risposta 201
Terminals
6 endpoint
Le descrizioni degli endpoint provengono direttamente dall'API e sono in tedesco.
Terminals auflisten
get/v1/terminals
Gekoppelte PAX IM30.
Risposta 200TerminalList
| Nome | Tipo | Descrizione |
|---|---|---|
objectobbligatorio | "list" | |
dataobbligatorio | Terminal[] | |
has_moreobbligatorio | boolean |
Errori possibili
- 400 Anfrage ungültig
- 401 Nicht angemeldet
- 403 Berechtigung fehlt
- 404 Nicht gefunden
- 409 Zustand passt nicht
- 429 Zu viele Anfragen
curl -X GET https://api.ladehase.com/v1/terminals \n -H "Authorization: Bearer lh_test_…"{
"object": "list",
"data": [
{
"id": "trm_6b0c2d8e1f3a5b7c",
"object": "terminal",
"name": "string",
"model": "string",
"location_id": "string",
"integration_id": "string",
"external_terminal_id": "string",
"paired": true,
"online": true,
"app_version": "string",
"last_seen_at": "2026-10-25T08:30:00.000Z",
"created_at": "string"
}
],
"has_more": true
}Terminal anlegen
post/v1/terminals
Neues PAX IM30 für einen Standort. Antwort enthält den Wartungs-PIN (nur einmal sichtbar).
Parametri
| Nome | Posizione | Tipo |
|---|---|---|
idempotency-keyfacoltativoWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden) | Intestazione | string |
Richiesta
| Nome | Tipo | Descrizione |
|---|---|---|
namefacoltativo | string | |
location_idobbligatorio | string | |
integration_idfacoltativo | string | null | |
external_terminal_idfacoltativo | string | null | |
maintenance_pinfacoltativo | string |
Risposta 201Terminal
| Nome | Tipo | Descrizione |
|---|---|---|
idobbligatorio | string | ID mit Präfix «trm_» |
objectobbligatorio | "terminal" | |
nameobbligatorio | string | |
modelobbligatorio | string | |
location_idobbligatorio | string | |
integration_idobbligatorio | string | null | |
external_terminal_idobbligatorio | string | null | Terminal-ID bei Freika |
pairedobbligatorio | boolean | |
onlineobbligatorio | boolean | |
app_versionobbligatorio | string | null | |
last_seen_atobbligatorio | string | null | Zeitpunkt (ISO 8601, UTC) |
created_atobbligatorio | string |
Errori possibili
- 400 Anfrage ungültig
- 401 Nicht angemeldet
- 403 Berechtigung fehlt
- 404 Nicht gefunden
- 409 Zustand passt nicht
- 429 Zu viele Anfragen
curl -X POST https://api.ladehase.com/v1/terminals \n -H "Authorization: Bearer lh_test_…" \n -H "Content-Type: application/json" \n -d '{"name":"PAX IM30","location_id":"string","integration_id":"string","external_terminal_id":"string","maintenance_pin":"string"}'{
"id": "trm_6b0c2d8e1f3a5b7c",
"object": "terminal",
"name": "string",
"model": "string",
"location_id": "string",
"integration_id": "string",
"external_terminal_id": "string",
"paired": true,
"online": true,
"app_version": "string",
"last_seen_at": "2026-10-25T08:30:00.000Z",
"created_at": "string"
}Freika-Terminals
get/v1/terminals/available
Terminals im verbundenen Freika-Konto zur Auswahl beim Koppeln.
Risposta 200Object
Errori possibili
- 400 Anfrage ungültig
- 401 Nicht angemeldet
- 403 Berechtigung fehlt
- 404 Nicht gefunden
- 409 Zustand passt nicht
- 429 Zu viele Anfragen
curl -X GET https://api.ladehase.com/v1/terminals/available \n -H "Authorization: Bearer lh_test_…"{}Terminal ändern
patch/v1/terminals/{id}
Name, Standort, Freika-Terminal, Wartungs-PIN.
Parametri
| Nome | Posizione | Tipo |
|---|---|---|
idobbligatorio | Percorso | string |
Richiesta
| Nome | Tipo | Descrizione |
|---|---|---|
namefacoltativo | string | |
location_idfacoltativo | string | |
integration_idfacoltativo | string | null | |
external_terminal_idfacoltativo | string | null | |
maintenance_pinfacoltativo | string |
Risposta 200Terminal
| Nome | Tipo | Descrizione |
|---|---|---|
idobbligatorio | string | ID mit Präfix «trm_» |
objectobbligatorio | "terminal" | |
nameobbligatorio | string | |
modelobbligatorio | string | |
location_idobbligatorio | string | |
integration_idobbligatorio | string | null | |
external_terminal_idobbligatorio | string | null | Terminal-ID bei Freika |
pairedobbligatorio | boolean | |
onlineobbligatorio | boolean | |
app_versionobbligatorio | string | null | |
last_seen_atobbligatorio | string | null | Zeitpunkt (ISO 8601, UTC) |
created_atobbligatorio | string |
Errori possibili
- 400 Anfrage ungültig
- 401 Nicht angemeldet
- 403 Berechtigung fehlt
- 404 Nicht gefunden
- 409 Zustand passt nicht
- 429 Zu viele Anfragen
curl -X PATCH https://api.ladehase.com/v1/terminals/{id} \n -H "Authorization: Bearer lh_test_…" \n -H "Content-Type: application/json" \n -d '{"name":"PAX IM30","location_id":"string","integration_id":"string","external_terminal_id":"string","maintenance_pin":"string"}'{
"id": "trm_6b0c2d8e1f3a5b7c",
"object": "terminal",
"name": "string",
"model": "string",
"location_id": "string",
"integration_id": "string",
"external_terminal_id": "string",
"paired": true,
"online": true,
"app_version": "string",
"last_seen_at": "2026-10-25T08:30:00.000Z",
"created_at": "string"
}Terminal entfernen
delete/v1/terminals/{id}
Die App muss danach neu gekoppelt werden.
Parametri
| Nome | Posizione | Tipo |
|---|---|---|
idobbligatorio | Percorso | string |
Risposta 200Deleted
| Nome | Tipo | Descrizione |
|---|---|---|
idobbligatorio | string | |
objectobbligatorio | string | |
deletedobbligatorio | true |
Errori possibili
- 400 Anfrage ungültig
- 401 Nicht angemeldet
- 403 Berechtigung fehlt
- 404 Nicht gefunden
- 409 Zustand passt nicht
- 429 Zu viele Anfragen
curl -X DELETE https://api.ladehase.com/v1/terminals/{id} \n -H "Authorization: Bearer lh_test_…"{
"id": "string",
"object": "string",
"deleted": true
}Kopplungscode
post/v1/terminals/{id}/pairing_codes
Code und QR-Inhalt zum Koppeln der Terminal-App (15 Minuten gültig).
Parametri
| Nome | Posizione | Tipo |
|---|---|---|
idobbligatorio | Percorso | string |
idempotency-keyfacoltativoWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden) | Intestazione | string |
Risposta 201Object
Errori possibili
- 400 Anfrage ungültig
- 401 Nicht angemeldet
- 403 Berechtigung fehlt
- 404 Nicht gefunden
- 409 Zustand passt nicht
- 429 Zu viele Anfragen
curl -X POST https://api.ladehase.com/v1/terminals/{id}/pairing_codes \n -H "Authorization: Bearer lh_test_…"{}