Cet article explique comment utiliser les API dans la DevZone avec EloView 4
Ci-dessous est décrit comment utiliser les API dans l'Elo DevZone. Cet article couvre les points suivants :
1. Générer des identifiants OAuth
2. Obtenir un jeton d'authentification
3. Autoriser les API
4. Obtenir OrgId :
5. Exécuter l'API
1. Générer des identifiants OAuth
OAuth (Open Authorization) est un protocole d'autorisation à standard ouvert qui offre aux applications la possibilité d'un « accès désigné sécurisé ». Cela sera utilisé pour obtenir le jeton d'autorisation.
a. Connectez-vous au site EloView : https://secure.eloview.com/
b. Cliquez sur l'icône de profil
c. Cliquez sur Générer des identifiants OAuth
d. Copiez et collez les identifiants OAuth (clientID et clientSecret) dans un bloc-notes, puis cliquez sur OK
2. Obtenir un jeton d'authentification
C'est le processus d'authentification des utilisateurs ou des processus pour des applications dans le cloud. L'application de l'utilisateur envoie une demande au service d'authentification, qui confirme l'identité de l'utilisateur et délivre un jeton. L'utilisateur peut alors accéder à l'application.
a. Cliquez sur l'onglet API
b. Développez la Grille d'authentification et cliquez sur le bouton « Essayez-le » (montré dans l'image ci-dessous), cela vous permettra d'entrer des valeurs pour les paramètres requis & affichera le bouton exécuter en bas de la boîte API.
c. Ajoutez Client Id (paramètre de chemin) et clientsecret comme paramètre de corps (reçu des identifiants OAuth / Étape 1), puis cliquez sur exécuter.
d. Cela fournira le jeton d'authentification qui peut être utilisé pour d'autres opérations.
e. Vérifiez le corps de la réponse & copiez le access_token de la réponse. Cela sera utilisé comme jeton Bearer pour accéder aux autres API. La réponse ressemblera à l'image ci-dessous.
3. Autoriser les API
Les jetons d'accès sont ce que les applications utilisent pour faire des demandes d'API au nom d'un utilisateur. Le jeton d'accès représente l'autorisation d'une application spécifique d'accéder à des parties spécifiques des données d'un utilisateur.
a Cliquez sur le bouton Autoriser situé en haut à droite de l'écran.
b Une fenêtre de dialogue s'ouvrira où nous pouvons ajouter la valeur du jeton d'accès pour autoriser les API.
c. Tapez bearer & collez le jeton d'accès dans le champ de saisie.
d. Cliquez sur le bouton Autoriser & fermez la fenêtre contextuelle
e. Maintenant, l'utilisateur est autorisé à accéder à n'importe quelle API disponible.
4. Obtenir OrgId :
OrgId (identifiant d'organisation) sera utilisé pour effectuer différentes actions API depuis la DevZone.
a. Cliquez sur l'icône Engrenage
b. L'OrgId se trouve dans le coin inférieur droit
5. Exécuter l'API
Une fois l'autorisation terminée, nous pouvons exécuter les API depuis la DevZone.
a. Développez le module par exemple Contenu / Obtenir la liste de contenu
b. Cliquez sur Essayez-le
c. Entrez ORG ID
d. Sélectionnez Exécuter
Les résultats devraient ressembler à ceci :
Please report any broken links by emailing support@elotouch.com and include a link to the knowledge article