QR-Codes

6 Endpunkte

QR-Codes auflisten

get/v1/codes

Statische QR-Codes mit URL und Anzahl Scans.

Antwort 200CodeList

Name	Typ	Beschreibung
`object`Pflicht	"list"
`data`Pflicht	Code[]
`has_more`Pflicht	boolean

Mögliche Fehler

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

Beispiel

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

Antwort 200

{
  "object": "list",
  "data": [
    {
      "id": "qr_3c9a1e7b0d2f4a6c",
      "object": "code",
      "code": "k7m2p9x",
      "target": "connector",
      "connector_id": "string",
      "location_id": "string",
      "label": "string",
      "url": "https://hof-meier.ladehase.com/k7m2p9x",
      "display_url": "string",
      "scans": 0,
      "disabled": true,
      "created_at": "string"
    }
  ],
  "has_more": true
}

QR-Code anlegen

post/v1/codes

Für einen Ladepunkt oder einen ganzen Standort (Auswahl auf der Bezahlseite).

Parameter

Name	Ort	Typ
`idempotency-key`optionalWiederholbare Anfragen ohne doppelte Wirkung (24 Stunden)	Kopfzeile	string

Anfrage

Name	Typ	Beschreibung
`target`Pflicht	"connector" \| "location"
`connector_id`optional	string
`location_id`optional	string
`label`optional	string

Antwort 201Code

Name	Typ	Beschreibung
`id`Pflicht	string	ID mit Präfix «qr_»
`object`Pflicht	"code"
`code`Pflicht	string	Kurzcode auf dem Schild
`target`Pflicht	"connector" \| "location"
`connector_id`Pflicht	string \| null
`location_id`Pflicht	string \| null
`label`Pflicht	string \| null
`url`Pflicht	string
`display_url`Pflicht	string
`scans`Pflicht	integer
`disabled`Pflicht	boolean
`created_at`Pflicht	string

Mögliche Fehler

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

Beispiel

curl -X POST https://api.ladehase.com/v1/codes \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"target":"connector","connector_id":"string","location_id":"string","label":"string"}'

Antwort 201

{
  "id": "qr_3c9a1e7b0d2f4a6c",
  "object": "code",
  "code": "k7m2p9x",
  "target": "connector",
  "connector_id": "string",
  "location_id": "string",
  "label": "string",
  "url": "https://hof-meier.ladehase.com/k7m2p9x",
  "display_url": "string",
  "scans": 0,
  "disabled": true,
  "created_at": "string"
}

QR-Code abrufen

get/v1/codes/{id}

Ein QR-Code.

Parameter

Name	Ort	Typ
`id`Pflicht	Pfad	string

Antwort 200Code

Name	Typ	Beschreibung
`id`Pflicht	string	ID mit Präfix «qr_»
`object`Pflicht	"code"
`code`Pflicht	string	Kurzcode auf dem Schild
`target`Pflicht	"connector" \| "location"
`connector_id`Pflicht	string \| null
`location_id`Pflicht	string \| null
`label`Pflicht	string \| null
`url`Pflicht	string
`display_url`Pflicht	string
`scans`Pflicht	integer
`disabled`Pflicht	boolean
`created_at`Pflicht	string

Mögliche Fehler

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

Beispiel

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

Antwort 200

{
  "id": "qr_3c9a1e7b0d2f4a6c",
  "object": "code",
  "code": "k7m2p9x",
  "target": "connector",
  "connector_id": "string",
  "location_id": "string",
  "label": "string",
  "url": "https://hof-meier.ladehase.com/k7m2p9x",
  "display_url": "string",
  "scans": 0,
  "disabled": true,
  "created_at": "string"
}

QR-Code ändern

patch/v1/codes/{id}

Bezeichnung ändern oder deaktivieren.

Parameter

Name	Ort	Typ
`id`Pflicht	Pfad	string

Anfrage

Name	Typ	Beschreibung
`label`optional	string
`disabled`optional	boolean

Antwort 200Code

Name	Typ	Beschreibung
`id`Pflicht	string	ID mit Präfix «qr_»
`object`Pflicht	"code"
`code`Pflicht	string	Kurzcode auf dem Schild
`target`Pflicht	"connector" \| "location"
`connector_id`Pflicht	string \| null
`location_id`Pflicht	string \| null
`label`Pflicht	string \| null
`url`Pflicht	string
`display_url`Pflicht	string
`scans`Pflicht	integer
`disabled`Pflicht	boolean
`created_at`Pflicht	string

Mögliche Fehler

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

Beispiel

curl -X PATCH https://api.ladehase.com/v1/codes/{id} \n  -H "Authorization: Bearer lh_test_…" \n  -H "Content-Type: application/json" \n  -d '{"label":"string","disabled":true}'

Antwort 200

{
  "id": "qr_3c9a1e7b0d2f4a6c",
  "object": "code",
  "code": "k7m2p9x",
  "target": "connector",
  "connector_id": "string",
  "location_id": "string",
  "label": "string",
  "url": "https://hof-meier.ladehase.com/k7m2p9x",
  "display_url": "string",
  "scans": 0,
  "disabled": true,
  "created_at": "string"
}

QR-Code als SVG

get/v1/codes/{id}/qr.svg

Mit Bildmarke in der Mitte.

Parameter

Name	Ort	Typ
`id`Pflicht	Pfad	string

Mögliche Fehler

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

Beispiel

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

QR-Code als PNG

get/v1/codes/{id}/qr.png

1024 × 1024 Pixel.

Parameter

Name	Ort	Typ
`id`Pflicht	Pfad	string

Mögliche Fehler

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

Beispiel

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