|
|
|
@ -0,0 +1,86 @@
|
|
|
|
|
*** |
|
|
|
|
|
|
|
|
|
titre : 'Jetons API' |
|
|
|
|
description: 'Cet article explique comment créer et utiliser des jetons API.' |
|
|
|
|
balises : \['Paramètres du compte', 'Jetons API'] |
|
|
|
|
mots-clés : \['jetons API', 'créer un jeton API', 'supprimer un jeton API'] |
|
|
|
|
--------------------------------------------------------------------------- |
|
|
|
|
|
|
|
|
|
## Créer un jeton API |
|
|
|
|
|
|
|
|
|
Ouvrez la page Paramètres du compte à partir du menu utilisateur dans le coin inférieur gauche de la barre latérale. |
|
|
|
|
|
|
|
|
|
1. Cliquer sur`User menu`dans le coin inférieur gauche de la barre latérale, |
|
|
|
|
2. Sélectionner`Account Settings`depuis la liste déroulante |
|
|
|
|
|
|
|
|
|
![profile page](/img/v2/account-settings/account-settings.png) |
|
|
|
|
|
|
|
|
|
Suivez les étapes ci-dessous pour créer un jeton API |
|
|
|
|
|
|
|
|
|
1. Cliquer sur`Tokens`onglet dans le`Account Settings`page |
|
|
|
|
2. Cliquer sur`Add New API Token` |
|
|
|
|
3. Entrez le nom du jeton API |
|
|
|
|
4. Cliquer sur`Save`bouton pour enregistrer les modifications |
|
|
|
|
5. Copiez le Token API en cliquant sur`Copy`bouton affiché sous`Actions`menu |
|
|
|
|
6. Utilisez le jeton API dans les services qui nécessitent son authentification en tant que`xc-token`dans les en-têtes. |
|
|
|
|
|
|
|
|
|
```json |
|
|
|
|
{ |
|
|
|
|
"headers": { |
|
|
|
|
"xc-token": "Copied API token here under quotes" |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
![Create API Token](/img/v2/account-settings/api-token-1.png) |
|
|
|
|
|
|
|
|
|
![Create API Token](/img/v2/account-settings/api-token-2.png) |
|
|
|
|
|
|
|
|
|
:::avertissement |
|
|
|
|
|
|
|
|
|
* Un seul token peut être créé par utilisateur |
|
|
|
|
* Le jeton API n'expire pas, mais il peut être supprimé à tout moment. |
|
|
|
|
::: |
|
|
|
|
|
|
|
|
|
Le jeton API créé sera ajouté à la liste. Copiez le jeton API en cliquant sur`Copy`bouton affiché sous`Actions`menu |
|
|
|
|
|
|
|
|
|
![Create API Token](/img/v2/account-settings/api-token-3.png) |
|
|
|
|
|
|
|
|
|
## Supprimer le jeton API |
|
|
|
|
|
|
|
|
|
Ouvrez la page Paramètres du compte à partir du menu utilisateur dans le coin inférieur gauche de la barre latérale. |
|
|
|
|
|
|
|
|
|
1. Click on `User menu`dans le coin inférieur gauche de la barre latérale, |
|
|
|
|
2. Sélectionner`Account Settings`depuis la liste déroulante |
|
|
|
|
|
|
|
|
|
![profile page](/img/v2/account-settings/account-settings.png) |
|
|
|
|
|
|
|
|
|
1. Click on `Tokens`onglet dans le`Account Settings`page |
|
|
|
|
2. Du`Actions`menu, cliquez sur`Delete`bouton associé au Token API à supprimer |
|
|
|
|
|
|
|
|
|
![Delete API Token](/img/v2/account-settings/api-token-4.png) |
|
|
|
|
|
|
|
|
|
:::avertissement |
|
|
|
|
Notez que tous les services utilisant le jeton API cesseront de fonctionner une fois le jeton API supprimé. |
|
|
|
|
::: |
|
|
|
|
|
|
|
|
|
## Jetons d'authentification |
|
|
|
|
|
|
|
|
|
Pour des expériences rapides avec l'API, vous pouvez utiliser le`Auth Tokens`pour générer un jeton temporaire. Ces jetons sont valables pour une session jusqu'à la déconnexion de l'utilisateur ou pendant 10 heures. |
|
|
|
|
|
|
|
|
|
Suivez les étapes ci-dessous pour copier le jeton AUTH |
|
|
|
|
|
|
|
|
|
1. Cliquer sur`User menu`dans le coin inférieur gauche de la barre latérale, |
|
|
|
|
2. Sélectionner`Copy Auth Token`depuis la liste déroulante |
|
|
|
|
|
|
|
|
|
```json |
|
|
|
|
{ |
|
|
|
|
"headers": { |
|
|
|
|
"xc-auth": "Copied auth token here under quotes" |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
:::note |
|
|
|
|
Pour l'auto-hébergé, vous pouvez reconfigurer le délai d'expiration à l'aide de la variable d'environnement`NC_JWT_EXPIRES_IN`. La valeur par défaut est 10 heures. |
|
|
|
|
::: |