API Key Gestion

Afficher en Markdown

API Key terminaux de gestion n’acceptent que JWT authentification.

Créez API Key

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

Paramètres de la demande :

ParamètreTypeObligatoireDescription
labelstringOuiAPI Key étiquette, longueur 1 - 64
permissionsintNonMasque de bitage de permission, 1par défaut, plage 1 - 7
ipWhitelistficelle[]NonIP liste blanche, jusqu’à 20 entrées. Si elle est omise, la IP source est non restreinte

Exemple de demande :

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

Exemple de réponse :

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

apiSecret n’est retourné qu’une seule fois lors de la création du API Key . Stockez-le immédiatement dans un système de gestion secrète. Ne l’écrivez pas dans les dépôts ou journaux du code source.

Chaque utilisateur peut créer jusqu’à 30 API Clés.

Liste API clés

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

Champs de réponse :

TerrainTypeDescription
list[].idstringAPI Key ID
list[].labelstringLabel
list[].apiKeystringIdentifiant public API Key
list[].permissionsintMasque de bitmask de permission
list[].ipWhitelistficelle[]IP liste blanche
list[].statusintStatut : 1 activé, 0 désactivé
list[].lastUsedAtint64Dernière utilisation
list[].createdAtint64Temps de création

Mise à jour API Key

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

Paramètres de la demande :

ParamètreTypeObligatoireDescription
idstringOuiAPI Key ID
labelstringNonNouveau label
permissionsintNonNouveau masque bitman de permission
ipWhitelistficelle[]NonListe blanche de la Nouvelle IP
statusintNon1 activé, 0 désactivé

Supprimer API Key

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

Corps de la demande :

{ "id": "1001" }

Supprimer toutes les API clés

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

Champs de réponse :

TerrainTypeDescription
deletedint64Nombre de clés API supprimées