Types d'application pour l'API REST BarTender Cloud
Question
Quels types de logiciels peuvent effectuer des appels RESTful vers l'API REST? Que sont les différences?
Applicable à
- API REST BarTender Cloud
- Abonnements Automation
Réponse
Lors des appels d'API REST, le logiciel doit envoyer un jeton et être autorisée avant que la passerelle API ne traite les appels. Alors que les deux types de logiciels nécessitent un jeton pour franchir la barrière de sécurité, la méthode d'obtention du jeton diffère.
Les deux types de logiciels sont :
- Logiciels privés/directs : Insomnie, Postman, etc.
- Applications Web - logiciels personnalisés
Logiciels privés
Les logiciels privés, parfois appelés logiciels directs, envoient un appel API directement à l'API REST et n'effectuent aucun appel supplémentaire en dehors de ces API appels. Des logiciels comme Insomnia et Postman entrent dans cette catégorie.
Un logiciel direct utilise un jeton pour traverser le portail de sécurité et exécuter des Appels API.
Le token doit être récupéré manuellement depuis l'interface web dans Cloud et peut être trouvé sous la section Cloud API dans les paramètres du profil ou dans Gérer le compte Cloud :
Pour les logiciels directs, le jeton de sécurité doit être envoyé avec chaque appel d'API. Dans Insomnia, par exemple, l'onglet Auth peut contenir le jeton. Le jeton est répertorié en tant que jeton porteur (un jeton d'autorisation donné par le porteur du message alias de Insomnie). Une fois que vous avez sélectionné l'option de jeton, collez votre jeton et il sera transporté avec le message API.
Applications web
Les applications Web sont créées dans des langages tels que C # et agissent comme une interface. Elle permet les interactions de l'utilisateur, y compris la connexion pour s'authentifier avec la Cloud. Ces types d'applications ont des étapes supplémentaires pour récupérer un jeton et finalement passer par le portail de sécurité et effectuer des appels API. Voici un schéma généralisé du processus d'autorisation.
Pourquoi choisir cette option plutôt qu'une application directe, si cela implique toutes ces étapes supplémentaires? Le processus d'authentification avec le fournisseur d'identité OAuth actualise la sécurité jeton à chaque connexion et l'utilisateur n'a jamais à gérer directement les jetons. Tout est géré par OAuth et l'application elle-même. Pour autant, une fois que l'application a un jeton valide, elle peut commencer à envoyer des appels d'API et passer par le portail de securité.
Les applications Web doivent être enregistrées dans Cloud. Cela garantit que seuls les applications autorisées peuvent travailler avec la Cloud. Tous ceux qui ne sont pas autorisé se verront refuser l'accès. L'enregistrement se trouve sur l'interface Web Cloud sous la section Cloud API dans les paramètres de votre profil utilisateur ou dans Gérer le compte Cloud.
Lors de l'enregistrement d'une application Web, on vous posera un certain nombre de questions sur l'application elle-même. Chaque champ vous offre une petite description (sauf le nom et la description, qui sont assez évidents) pour que vous puissiez entrer l'information correcte pour chacun des champs et l'application est enregistrée correctement.
Toutes les applications apparaîtront dans la liste sous la section Web Application Registration
Il y a plusieurs exemples de comment d'écrire une application Web personnalisée et comment générer le dialogue d'authentification. Pour réviser les exemples ainsi que plus d'informations sur le sujet, veuillez consulter notre aide BarTender Cloud ici.