API v1

ClearDrive API

Programmatischer Zugriff auf Kunden, Zertifikate und Protokolle deines ClearDrive-Accounts. API-Keys werden im Kunden-Dashboard unter clear-drive.de/account/api-keys erstellt und verwaltet (Premium-Feature).

Authentifizierung

Jede Anfrage benötigt einen Authorization-Header mit deinem API-Key:

Authorization: Bearer cd_live_dein_api_key_hier

Ein Key gewährt Vollzugriff (lesend) auf alle Daten deines Accounts – inklusive geteilter Team-Daten, falls dein Account Teil eines Teams ist. Es gibt in v1 keine eingeschränkten Keys (Scopes).

Keys sind an eine aktive Premium-Lizenz gebunden. Läuft die Lizenz ab oder wird der Account herabgestuft, wird der Key automatisch inaktiv (Fehler 402), auch ohne ihn manuell zu widerrufen.

Rate-Limit

Maximal 60 Anfragen pro Minute pro Key. Bei Überschreitung: 429 Too Many Requests.

Endpunkte

GET/v1/customers

Liste aller Kunden deines Accounts (bzw. deines Teams).

GET/v1/customers/{id}

Einzelner Kunde inkl. Anzahl ausgestellter Zertifikate.

GET/v1/customers/{id}/certificates

Alle Zertifikate, die mit diesem Kunden verknüpft sind. Nur Zertifikate, die bei der Erstellung einem echten Kunden-Datensatz zugeordnet wurden, tauchen hier auf.

GET/v1/certificates

Liste aller Zertifikate. Optionale Query-Parameter:

Parameter	Beschreibung
`customer_id`	nur Zertifikate dieses Kunden
`since` / `until`	ISO-8601-Datumsbereich (issued_at)
`limit`	max. Ergebnisse, Standard 50, maximal 200
`offset`	Pagination-Offset, Standard 0

GET/v1/certificates/{report_id}

Metadaten eines einzelnen Zertifikats (Datum, Methode, Laufwerk, Status, Kunde).

GET/v1/certificates/{report_id}/download

Liefert das entschlüsselte Zertifikat-PDF als Datei-Download.

GET/v1/protocols/{device_id}/{wipe_id}

Technisches Protokoll (Logs, SMART-Daten, Löschdurchgänge) – liegt nur auf der Station und wird live abgefragt. Antwortet mit 504, wenn die Station gerade nicht online ist. Es gibt keine zentrale Protokoll-Historie auf dem Server.

Beispiel

curl https://api.clear-drive.de/v1/customers \
  -H "Authorization: Bearer cd_live_xxxxxxxxxxxxxxxxxxxxxxxx"

{
  "ok": true,
  "customers": [
    {
      "id": 12,
      "name": "Autohaus Mustermann",
      "company": "Mustermann GmbH",
      "certificate_count": 7,
      "updated_at": "2026-07-10T14:22:00"
    }
  ]
}

Fehlercodes

Code	Bedeutung
401	API-Key fehlt, ist ungültig oder wurde widerrufen
402	Account hat keine aktive Premium-Lizenz mehr
404	Ressource existiert nicht oder gehört nicht zu deinem Account
429	Rate-Limit überschritten
504	Station antwortet nicht (nur bei /v1/protocols)