1. API

1.1. Authentification

L'authentification sur l'API de la GBox peut se faire de deux manières :

En utilisant d'un couple login / mot de passe.
En utilisant d'un token d'api.

1.1.1. Création d'un token d'API

_images/admin_required.png

Menu : Administrators > GBOX > Accounts > API Tokens

Les paramètres d'un token sont les suivants :

Nom (requis) : Un nom permettant d'identifier le possesseur ou l'utilisation faite du token.
Permissions (requis) : Il s'agit du niveau d'accès du token parmi Operators,Administrators ou Super Administrator.
Une date d'expiration : Permettant de désactiver le token à la date et l'heure indiquée. Si ce champ n'est pas rempli, le token n'expire pas.

Les tokens ayant expiré peuvent être purgés de la liste en cliquant sur le bouton Purge expired tokens ou via l'API /auth/tokens/purge-tokens/.

Note

Si un token expiré est utilisé pour accéder à l'API, une erreur indiquant que le token est expiré/invalide sera retournée, et le token sera automatiquement supprimé

Le token d'api est fourni dans le champ "API-KEY".

_images/api_token.png

1.2. Documentation de l'API

La documentation de l'API de la GBox est disponible via Swagger en cliquant sur le lien présent dans le menu Administrators > GBOX > API ou via l'adresse http://gbox/api/docs/swagger/.