API Key Zarządzanie

Zobacz jako Markdown

API Key endpointy zarządzania akceptują tylko JWT uwierzytelnianie.

Stwórz API Key

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

Parametry żądania:

ParametrTypWymaganeOpis
labelstringTakAPI Key etykieta, długość 1 - 64
permissionsintNieBitmaska uprawnień, domyślny 1, zakres 1 - 7
ipWhitelistString[]NieIP białej liście, do 20 wpisów. Jeśli zostanie pominięte, źródło IP jest nieograniczone

Przykład prośby:

$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"]
> }'

Przykład odpowiedzi:

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

apiSecret jest zwracany tylko raz po utworzeniu API Key . Natychmiast przechowuj go w systemie zarządzania tajemnicami. Nie zapisuj go w repozytoriach kodu źródłowego ani logach.

Każdy użytkownik może stworzyć do 30 kluczy API .

Lista API Kluczy

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

Pola odpowiedzi:

PoleTypOpis
list[].idstringAPI Key ID
list[].labelstringWytwórnia
list[].apiKeystringPubliczny identyfikator API Key
list[].permissionsintPermission bitmask
list[].ipWhitelistString[]IP biała lista
list[].statusintStatus: 1 włączony, 0 wyłączony
list[].lastUsedAtint64Ostatni czas użytkowania
list[].createdAtint64Czas tworzenia

Aktualizacja API Key

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

Parametry żądania:

ParametrTypWymaganeOpis
idstringTakAPI Key ID
labelstringNieNowa wytwórnia
permissionsintNieNowe zezwolenie bitmask
ipWhitelistString[]NieNowa IP biała lista
statusintNie1 włączone, 0 wyłączone

Usuń API Key

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

Główna część zgłoszenia:

1{ "id": "1001" }

Usuń wszystkie API klucze

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

Pola odpowiedzi:

PoleTypOpis
deletedint64Liczba usuniętych API Kluczy