Lors de la connexion aux APIs NetExplorer, passez dès maintenant, par une authentification en OAuth2.
Cet article vous explique comment configurer votre application
Connectez vos applications ou scripts, via l'application OAuth2, que votre plateforme NetExplorer vous propose de mettre en place. Vous aurez ainsi la possibilité de choisir le type de connexion utilisée.
Sur votre plateforme
En tant qu'administrateur, placez-vous, lors de la connexion via navigateur, sur le menu en bas à gauche de l'écran Une fois placé sur ce menu, choisissez l'onglet
, à l'extrémité de la page centrale, cliquez alors simplement sur le bouton
Création de votre application OAuth2
Lors du clic sur le bouton de c'éation, apparaît la fenêtre ci-dessous
- Vous pouvez attribuer un logo à votre application d'authentification en cliquant sur
- Donnez un nom à votre application OAuth2
- Ajoutez un description à l'utilisation de votre application
- Le nom de l'éditeur ou créateur de cette application
- Le site de l'éditeur ou créateur concerné.
- Les éventuelles urls de callback à implémenter lors d'une connexion cliente
- Vous allez, en cliquant sur ce bouton, sélectionner les scopes de droits attribuiés à votre application (expliqué dans le chapitre au dessous)
- Cette zone va vous permettre de définir le type d'application OAuth2 utilisée :
- Client : utiliser le profil d'un compte utilisateur existant sur la platerforme
- Par exemple: permettre un accès à vos applications, aux dossiers sur lesquels l'utilisateur a des droits
- Serveur : créer une application permettant des accès administrateur
- Par exemple: créer un script d'accès global à la plateforme, automatiser la création d'utilisateurs, uploader des fichiers...
- Client : utiliser le profil d'un compte utilisateur existant sur la platerforme
La sélection des scopes
Lors du clic sur le bouton (le point 7 dans le détail ci dessus) vous ouvrez une fenêtre, permettant de donner les droits nécessaires à votre application.
Suivant vos désidératas, vous pourrez alors accorder aux différentes appels listés dans les scopes (account, annotations, files...) les droits que doit avoir votre application, dès lors qu'un appel API est effectué :
- En lecture simple (read)
- En écriture simple (write)
- Tous les droits (read et write)
Le bouton vous permettant alors de donner les droits globaux à tous les appels.
Une fois les zones remplies, cliquez sur Sauvegarder.
Une fenêtre, montrant 2 paramètres nécessaires, s'affiche après la création de votre application :
- client_id : vous pourrez retrouver ce paramètre au sein de votre application, le cas échéant.
- client_secret : pensez bien à copier ce paramètre, vous n'y aurez plus accès par la suite.
La connexion de votre application, exemple avec Postman
Une fois l'application configurée, vous allez pouvoir appeler l'API d'authentification, au sein de vos éléments de script ou de code.
Nous allons voir ici comment appeller votre authentification via Postman.
Je vais donc passer, comme indiqué dans la documentation API, à cet endroit : https://api.netexplorer.fr/v3/#authorize les 3 paramètres nécessaires :
- client_id
- grant_type
- client_secret
Le but ici, est donc de récupérer un token de connexion de l'application OAuth2, en mode Serveur.