API Key Management

API Key Management-Endpunkte akzeptieren nur JWT Authentifizierung.

Erstellen Sie API Key

POST /v1/private/user/api-key/create
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

Anfrageparameter:

Parameter	Typ	Erforderlich	Beschreibung
`label`	string	Ja	API Key Label, Länge 1 - 64
`permissions`	Int	Nein	Berechtigungs-Bitmaske, Standard- `1`, Reichweite `1` - `7`
`ipWhitelist`	String[]	Nein	IP Whitelist bis zu 20 Einträge. Wenn ausgelassen, ist die Quelle IP unbeschränkt

Beispiel für eine Anfrage:

curl -X POST https://api.6mm.com/v1/private/user/api-key/create \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{
    "label": "external-service-prod",
    "permissions": 3,
    "ipWhitelist": ["203.0.113.10"]
  }'

Antwortbeispiel:

{
  "code": 0,
  "message": "success",
  "data": {
    "apiKey": "fx_xxxxxxxxxxxxxxxxxxxxxxxx",
    "apiSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "requestId": "req-api-key"
}

apiSecret wird nur einmal zurückgegeben, wenn das API Key erstellt wird. Speichern Sie es sofort in einem Geheimmanagementsystem. Schreiben Sie es nicht in Quellcode-Repositories oder Protokolle.

Jeder Nutzer kann bis zu 30 API Keys erstellen.

Liste API Schlüssel

GET /v1/private/user/api-key/list
Authorization: Bearer YOUR_ACCESS_TOKEN

Antwortfelder:

Spielfeld	Typ	Beschreibung
`list[].id`	string	API Key ID
`list[].label`	string	Label
`list[].apiKey`	string	Öffentliche API Key -Kennung
`list[].permissions`	Int	Erlaubnis-Bitmask
`list[].ipWhitelist`	String[]	IP Whitelist
`list[].status`	Int	Status: `1` aktiviert, `0` deaktiviert
`list[].lastUsedAt`	int64	Letzte verwendete Zeit
`list[].createdAt`	int64	Entstehungszeit

Update API Key

PUT /v1/private/user/api-key/update
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

Anfrageparameter:

Parameter	Typ	Erforderlich	Beschreibung
`id`	string	Ja	API Key ID
`label`	string	Nein	Neues Label
`permissions`	Int	Nein	Neue Berechtigungs-Bitmaske
`ipWhitelist`	String[]	Nein	Weißliste für neue IP
`status`	Int	Nein	`1` aktiviert, `0` deaktiviert

Lösche API Key

POST /v1/private/user/api-key/delete
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

Antragstext:

{ "id": "1001" }

Alle API Schlüssel löschen

POST /v1/private/user/api-key/delete-all
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json