API Key Management

API Key Management-Endpunkte akzeptieren nur JWT Authentifizierung.

Erstellen Sie API Key

1 POST /v1/private/user/api-key/create
2 Authorization: Bearer YOUR_ACCESS_TOKEN
3 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:

1 {
2   "code": 0,
3   "message": "success",
4   "data": {
5     "apiKey": "fx_xxxxxxxxxxxxxxxxxxxxxxxx",
6     "apiSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
7   },
8   "requestId": "req-api-key"
9 }

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

1 GET /v1/private/user/api-key/list
2 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

1 PUT /v1/private/user/api-key/update
2 Authorization: Bearer YOUR_ACCESS_TOKEN
3 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

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

Antragstext:

1 { "id": "1001" }

Alle API Schlüssel löschen

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