Zugänge

9 endpoint

Le descrizioni degli endpoint provengono direttamente dall'API e sono in tedesco.

Zugänge auflisten

get/v1/access_grants

Personen und Ladekarten, die gratis oder zum Sondertarif laden.

Risposta 200AccessGrantList

Nome	Tipo	Descrizione
`object`obbligatorio	"list"
`data`obbligatorio	AccessGrant[]
`has_more`obbligatorio	boolean

Errori possibili

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Esempio

curl -X GET https://api.ladehase.com/v1/access_grants \n  -H "Authorization: Bearer lh_test_…"

Risposta 200

{
  "object": "list",
  "data": [
    {
      "id": "acc_0e9d8c7b6a5f4e3d",
      "object": "access_grant",
      "name": "string",
      "email": "string",
      "rfid_uid": "string",
      "link_url": "string",
      "free": true,
      "tariff_id": "string",
      "monthly_limit_wh": 0,
      "revoked": true,
      "created_at": "string"
    }
  ],
  "has_more": true
}

Zugang anlegen

post/v1/access_grants

Ohne `tariff_id` gratis, mit `tariff_id` Sondertarif und Monatsabrechnung. Erzeugt einen persönlichen Link.

Parametri

Nome	Posizione	Tipo
`idempotency-key`facoltativoWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	Intestazione	string

Richiesta

Nome	Tipo	Descrizione
`name`obbligatorio	string
`email`facoltativo	string \| null
`rfid_uid`facoltativo	string \| null
`create_link`facoltativo	boolean
`valid_from`facoltativo	string \| null
`valid_until`facoltativo	string \| null
`device_ids`facoltativo	string[]
`tariff_id`facoltativo	string \| null
`monthly_limit_wh`facoltativo	integer \| null
`billing_integration_id`facoltativo	string \| null
`note`facoltativo	string \| null

Risposta 201AccessGrant

Nome	Tipo	Descrizione
`id`obbligatorio	string	ID mit Präfix «acc_»
`object`obbligatorio	"access_grant"
`name`obbligatorio	string
`email`obbligatorio	string \| null
`rfid_uid`obbligatorio	string \| null
`link_url`obbligatorio	string \| null	Persönlicher Link zum Laden ohne Zahlung
`free`obbligatorio	boolean
`tariff_id`obbligatorio	string \| null
`monthly_limit_wh`obbligatorio	integer \| null
`revoked`obbligatorio	boolean
`created_at`obbligatorio	string

Errori possibili

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Esempio

curl -X POST https://api.ladehase.com/v1/access_grants \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"name":"string","email":"person@example.ch","rfid_uid":"string","create_link":true,"valid_from":"2026-10-25T08:30:00.000Z","valid_until":"2026-10-25T08:30:00.000Z","device_ids":[],"tariff_id":"string","monthly_limit_wh":0,"billing_integration_id":"string","note":"string"}'

Risposta 201

{
  "id": "acc_0e9d8c7b6a5f4e3d",
  "object": "access_grant",
  "name": "string",
  "email": "string",
  "rfid_uid": "string",
  "link_url": "string",
  "free": true,
  "tariff_id": "string",
  "monthly_limit_wh": 0,
  "revoked": true,
  "created_at": "string"
}

Zugang abrufen

get/v1/access_grants/{id}

Ein Zugang.

Parametri

Nome	Posizione	Tipo
`id`obbligatorio	Percorso	string

Risposta 200AccessGrant

Nome	Tipo	Descrizione
`id`obbligatorio	string	ID mit Präfix «acc_»
`object`obbligatorio	"access_grant"
`name`obbligatorio	string
`email`obbligatorio	string \| null
`rfid_uid`obbligatorio	string \| null
`link_url`obbligatorio	string \| null	Persönlicher Link zum Laden ohne Zahlung
`free`obbligatorio	boolean
`tariff_id`obbligatorio	string \| null
`monthly_limit_wh`obbligatorio	integer \| null
`revoked`obbligatorio	boolean
`created_at`obbligatorio	string

Errori possibili

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Esempio

curl -X GET https://api.ladehase.com/v1/access_grants/{id} \n  -H "Authorization: Bearer lh_test_…"

Risposta 200

{
  "id": "acc_0e9d8c7b6a5f4e3d",
  "object": "access_grant",
  "name": "string",
  "email": "string",
  "rfid_uid": "string",
  "link_url": "string",
  "free": true,
  "tariff_id": "string",
  "monthly_limit_wh": 0,
  "revoked": true,
  "created_at": "string"
}

Zugang ändern

patch/v1/access_grants/{id}

Auch `revoked` und `regenerate_link`.

Parametri

Nome	Posizione	Tipo
`id`obbligatorio	Percorso	string

Richiesta

Nome	Tipo	Descrizione
`name`facoltativo	string
`email`facoltativo	string \| null
`rfid_uid`facoltativo	string \| null
`create_link`facoltativo	boolean
`valid_from`facoltativo	string \| null
`valid_until`facoltativo	string \| null
`device_ids`facoltativo	string[]
`tariff_id`facoltativo	string \| null
`monthly_limit_wh`facoltativo	integer \| null
`billing_integration_id`facoltativo	string \| null
`note`facoltativo	string \| null
`revoked`facoltativo	boolean
`regenerate_link`facoltativo	boolean

Risposta 200AccessGrant

Nome	Tipo	Descrizione
`id`obbligatorio	string	ID mit Präfix «acc_»
`object`obbligatorio	"access_grant"
`name`obbligatorio	string
`email`obbligatorio	string \| null
`rfid_uid`obbligatorio	string \| null
`link_url`obbligatorio	string \| null	Persönlicher Link zum Laden ohne Zahlung
`free`obbligatorio	boolean
`tariff_id`obbligatorio	string \| null
`monthly_limit_wh`obbligatorio	integer \| null
`revoked`obbligatorio	boolean
`created_at`obbligatorio	string

Errori possibili

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Esempio

curl -X PATCH https://api.ladehase.com/v1/access_grants/{id} \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"name":"string","email":"person@example.ch","rfid_uid":"string","create_link":true,"valid_from":"2026-10-25T08:30:00.000Z","valid_until":"2026-10-25T08:30:00.000Z","device_ids":[],"tariff_id":"string","monthly_limit_wh":0,"billing_integration_id":"string","note":"string","revoked":true,"regenerate_link":true}'

Risposta 200

{
  "id": "acc_0e9d8c7b6a5f4e3d",
  "object": "access_grant",
  "name": "string",
  "email": "string",
  "rfid_uid": "string",
  "link_url": "string",
  "free": true,
  "tariff_id": "string",
  "monthly_limit_wh": 0,
  "revoked": true,
  "created_at": "string"
}

Zugang widerrufen

delete/v1/access_grants/{id}

Link und Berechtigung werden ungültig.

Parametri

Nome	Posizione	Tipo
`id`obbligatorio	Percorso	string

Risposta 200Deleted

Nome	Tipo	Descrizione
`id`obbligatorio	string
`object`obbligatorio	string
`deleted`obbligatorio	true

Errori possibili

400 Anfrage ungültig
401 Nicht angemeldet
403 Berechtigung fehlt
404 Nicht gefunden
409 Zustand passt nicht
429 Zu viele Anfragen

Esempio

curl -X DELETE https://api.ladehase.com/v1/access_grants/{id} \n  -H "Authorization: Bearer lh_test_…"

Risposta 200

{
  "id": "string",
  "object": "string",
  "deleted": true
}

Monatsabrechnungen

get/v1/billing_statements

Abrechnungen für Zugänge mit Sondertarif.

Parametri

Nome	Posizione	Tipo
`period`facoltativo	Query	string

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

Esempio

curl -X GET https://api.ladehase.com/v1/billing_statements \n  -H "Authorization: Bearer lh_test_…"

Risposta 200

{}

Abrechnungen erstellen

post/v1/billing_statements/generate

Für einen Monat (`period` = JJJJ-MM).

Parametri

Nome	Posizione	Tipo
`idempotency-key`facoltativoWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	Intestazione	string

Richiesta

Nome	Tipo	Descrizione
`period`obbligatorio	string

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

Esempio

curl -X POST https://api.ladehase.com/v1/billing_statements/generate \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"period":"string"}'

Risposta 200

{}

Abrechnung senden

post/v1/billing_statements/{id}/send

E-Mail mit Zahlungslink über zahls.ch oder Freika.

Parametri

Nome	Posizione	Tipo
`id`obbligatorio	Percorso	string
`idempotency-key`facoltativoWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	Intestazione	string

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

Esempio

curl -X POST https://api.ladehase.com/v1/billing_statements/{id}/send \n  -H "Authorization: Bearer lh_test_…"

Risposta 200

{}

Als bezahlt markieren

post/v1/billing_statements/{id}/paid

Zum Beispiel bei Barzahlung.

Parametri

Nome	Posizione	Tipo
`id`obbligatorio	Percorso	string
`idempotency-key`facoltativoWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	Intestazione	string

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

Esempio

curl -X POST https://api.ladehase.com/v1/billing_statements/{id}/paid \n  -H "Authorization: Bearer lh_test_…"

Risposta 200

{}