Zum Inhalt springen

API-Schlüssel

POST /api/v1/api-keys

Erstellt einen neuen API-Schlüssel für den authentifizierten Benutzer.

{
"name": "Meine Integration"
}
FeldErforderlichBeschreibung
nameJaAnzeigename für den Schlüssel (1-100 Zeichen)
{
"data": {
"id": "key_uuid",
"name": "Meine Integration",
"prefix": "rm_abc123",
"key": "rm_abc123def456...",
"created_at": "2025-09-19T15:00:00.000Z"
}
}

GET /api/v1/api-keys

Gibt alle API-Schlüssel für den authentifizierten Benutzer zurück. Der vollständige Schlüsselwert wird nach der Erstellung niemals zurückgegeben.

{
"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
}
]
}

DELETE /api/v1/api-keys/:id

Widerruft einen API-Schlüssel dauerhaft. Anfragen, die diesen Schlüssel verwenden, schlagen sofort mit INVALID_API_KEY fehl.

{
"data": { "success": true }
}
CodeHTTP StatusBedeutung
API_KEY_NOT_FOUND404Schlüssel existiert nicht oder gehört einem anderen Benutzer
ALREADY_REVOKED400Schlüssel wurde bereits widerrufen