API Key Gestione

Visualizza come Markdown

API Key endpoint di gestione accettano solo JWT autenticazione.

Crea API Key

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

Parametri della richiesta:

ParametroTipoRichiestoDescrizione
labelstringAPI Key etichetta, lunghezza 1 - 64
permissionsintNoPermesso bitmaschera, 1predefinito, intervallo 1 - 7
ipWhiteliststring[]NoIP whitelist, fino a 20 voci. Se omesso, il IP di sorgente è senza restrizioni

Esempio di richiesta:

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

Esempio di risposta:

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

apiSecret viene restituito una sola volta quando il API Key viene creato. Memorizzalo immediatamente in un sistema di gestione segreto. Non scriverlo in repository o log del codice sorgente.

Ogni utente può creare fino a 30 chiavi API .

Elenco API Chiavi

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

Campi di risposta:

CampoTipoDescrizione
list[].idstringAPI Key ID
list[].labelstringEtichetta
list[].apiKeystringIdentificatore pubblico API Key
list[].permissionsintBitmask di permesso
list[].ipWhiteliststring[]IP whitelist
list[].statusintStato: 1 abilitato, 0 disabilitato
list[].lastUsedAtint64Ultimo tempo utilizzato
list[].createdAtint64Tempo di creazione

Aggiornamento API Key

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

Parametri della richiesta:

ParametroTipoRichiestoDescrizione
idstringAPI Key ID
labelstringNoNuova etichetta
permissionsintNoNuova bitmask di permesso
ipWhiteliststring[]NoWhitelist dei nuovi IP
statusintNo1 abilitato 0 disabilitato

Elimina API Key

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

Corpo della richiesta:

1{ "id": "1001" }

Elimina tutte le API chiavi

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

Campi di risposta:

CampoTipoDescrizione
deletedint64Numero di chiavi API eliminate