Hoppa till innehåll

API-nycklar

POST /api/v1/api-keys

Skapar en ny API-nyckel för den autentiserade användaren.

{
"name": "My integration"
}
FältObligatoriskBeskrivning
nameJaVisningsnamn för nyckeln (1–100 tecken)
{
"data": {
"id": "key_uuid",
"name": "My integration",
"prefix": "rm_abc123",
"key": "rm_abc123def456...",
"created_at": "2025-09-19T15:00:00.000Z"
}
}

GET /api/v1/api-keys

Returnerar alla API-nycklar för den autentiserade användaren. Det fullständiga nyckelvärdet returneras aldrig efter skapandet.

{
"data": [
{
"id": "key_uuid",
"name": "My 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

Återkallar permanent en API-nyckel. Förfrågningar som använder denna nyckel kommer omedelbart att misslyckas med INVALID_API_KEY.

{
"data": { "success": true }
}
KodHTTP-statusBetydelse
API_KEY_NOT_FOUND404Nyckeln finns inte eller tillhör en annan användare
ALREADY_REVOKED400Nyckeln har redan återkallats