API Key Gestion | 6MM Docs

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

Créez API Key

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

Paramètres de la demande :

Paramètre	Type	Obligatoire	Description
`label`	string	Oui	API Key étiquette, longueur 1 - 64
`permissions`	int	Non	Masque de bitage de permission, `1`par défaut, plage `1` - `7`
`ipWhitelist`	ficelle[]	Non	IP 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 :

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

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

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

Champs de réponse :

Terrain	Type	Description
`list[].id`	string	API Key ID
`list[].label`	string	Label
`list[].apiKey`	string	Identifiant public API Key
`list[].permissions`	int	Masque de bitmask de permission
`list[].ipWhitelist`	ficelle[]	IP liste blanche
`list[].status`	int	Statut : `1` activé, `0` désactivé
`list[].lastUsedAt`	int64	Dernière utilisation
`list[].createdAt`	int64	Temps de création

Mise à jour API Key

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

Paramètres de la demande :

Paramètre	Type	Obligatoire	Description
`id`	string	Oui	API Key ID
`label`	string	Non	Nouveau label
`permissions`	int	Non	Nouveau masque bitman de permission
`ipWhitelist`	ficelle[]	Non	Liste blanche de la Nouvelle IP
`status`	int	Non	`1` activé, `0` désactivé

Supprimer API Key

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

Corps de la demande :

1 { "id": "1001" }

Supprimer toutes les API clés

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