API-Schlüssel
API-Schlüssel erstellen
Abschnitt betitelt „API-Schlüssel erstellen“POST /api/v1/api-keysErstellt einen neuen API-Schlüssel für den authentifizierten Benutzer.
Anfragetext
Abschnitt betitelt „Anfragetext“{ "name": "Meine Integration"}| Feld | Erforderlich | Beschreibung |
|---|---|---|
name | Ja | Anzeigename für den Schlüssel (1-100 Zeichen) |
Antwort
Abschnitt betitelt „Antwort“{ "data": { "id": "key_uuid", "name": "Meine Integration", "prefix": "rm_abc123", "key": "rm_abc123def456...", "created_at": "2025-09-19T15:00:00.000Z" }}API-Schlüssel auflisten
Abschnitt betitelt „API-Schlüssel auflisten“GET /api/v1/api-keysGibt alle API-Schlüssel für den authentifizierten Benutzer zurück. Der vollständige Schlüsselwert wird nach der Erstellung niemals zurückgegeben.
Antwort
Abschnitt betitelt „Antwort“{ "data": [ { "id": "key_uuid", "name": "Meine Integration", "prefix": "rm_abc123", "created_at": "2025-09-19T15:00:00.000Z", "last_used_at": "2025-09-20T10:30:00.000Z", "is_revoked": false } ]}API-Schlüssel widerrufen
Abschnitt betitelt „API-Schlüssel widerrufen“DELETE /api/v1/api-keys/:idWiderruft einen API-Schlüssel dauerhaft. Anfragen, die diesen Schlüssel verwenden, schlagen sofort mit INVALID_API_KEY fehl.
Antwort
Abschnitt betitelt „Antwort“{ "data": { "success": true }}Fehlercodes
Abschnitt betitelt „Fehlercodes“| Code | HTTP Status | Bedeutung |
|---|---|---|
API_KEY_NOT_FOUND | 404 | Schlüssel existiert nicht oder gehört einem anderen Benutzer |
ALREADY_REVOKED | 400 | Schlüssel wurde bereits widerrufen |