Zugänge

9 endpoints

Les descriptions des endpoints proviennent directement de l'API et sont en allemand.

Zugänge auflisten

get/v1/access_grants

Personen und Ladekarten, die gratis oder zum Sondertarif laden.

Réponse 200AccessGrantList

Nom	Type	Description
`object`obligatoire	"list"
`data`obligatoire	AccessGrant[]
`has_more`obligatoire	boolean

Erreurs possibles

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

Exemple

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

Réponse 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.

Paramètres

Nom	Emplacement	Type
`idempotency-key`facultatifWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	En-tête	string

Requête

Nom	Type	Description
`name`obligatoire	string
`email`facultatif	string \| null
`rfid_uid`facultatif	string \| null
`create_link`facultatif	boolean
`valid_from`facultatif	string \| null
`valid_until`facultatif	string \| null
`device_ids`facultatif	string[]
`tariff_id`facultatif	string \| null
`monthly_limit_wh`facultatif	integer \| null
`billing_integration_id`facultatif	string \| null
`note`facultatif	string \| null

Réponse 201AccessGrant

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

Erreurs possibles

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

Exemple

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"}'

Réponse 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.

Paramètres

Nom	Emplacement	Type
`id`obligatoire	Chemin	string

Réponse 200AccessGrant

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

Erreurs possibles

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

Exemple

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

Réponse 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`.

Paramètres

Nom	Emplacement	Type
`id`obligatoire	Chemin	string

Requête

Nom	Type	Description
`name`facultatif	string
`email`facultatif	string \| null
`rfid_uid`facultatif	string \| null
`create_link`facultatif	boolean
`valid_from`facultatif	string \| null
`valid_until`facultatif	string \| null
`device_ids`facultatif	string[]
`tariff_id`facultatif	string \| null
`monthly_limit_wh`facultatif	integer \| null
`billing_integration_id`facultatif	string \| null
`note`facultatif	string \| null
`revoked`facultatif	boolean
`regenerate_link`facultatif	boolean

Réponse 200AccessGrant

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

Erreurs possibles

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

Exemple

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}'

Réponse 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.

Paramètres

Nom	Emplacement	Type
`id`obligatoire	Chemin	string

Réponse 200Deleted

Nom	Type	Description
`id`obligatoire	string
`object`obligatoire	string
`deleted`obligatoire	true

Erreurs possibles

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

Exemple

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

Réponse 200

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

Monatsabrechnungen

get/v1/billing_statements

Abrechnungen für Zugänge mit Sondertarif.

Paramètres

Nom	Emplacement	Type
`period`facultatif	Requête	string

Réponse 200Object

Erreurs possibles

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

Exemple

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

Réponse 200

{}

Abrechnungen erstellen

post/v1/billing_statements/generate

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

Paramètres

Nom	Emplacement	Type
`idempotency-key`facultatifWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	En-tête	string

Requête

Nom	Type	Description
`period`obligatoire	string

Réponse 200Object

Erreurs possibles

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

Exemple

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"}'

Réponse 200

{}

Abrechnung senden

post/v1/billing_statements/{id}/send

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

Paramètres

Nom	Emplacement	Type
`id`obligatoire	Chemin	string
`idempotency-key`facultatifWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	En-tête	string

Réponse 200Object

Erreurs possibles

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

Exemple

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

Réponse 200

{}

Als bezahlt markieren

post/v1/billing_statements/{id}/paid

Zum Beispiel bei Barzahlung.

Paramètres

Nom	Emplacement	Type
`id`obligatoire	Chemin	string
`idempotency-key`facultatifWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	En-tête	string

Réponse 200Object

Erreurs possibles

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

Exemple

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

Réponse 200

{}