Créer une API et l'utiliser

TABLE DES MATIÈRES
Introduction
Découvrir les avantages de l'API
Ajouter une API sur le portail Via HTML

Notes
I. La nouvelle version de Via HTML est présentement offerte en mode «Beta». Nous vous tiendrons informés de prochains développements et maintiendrons la présente documentation à jour;
II. Veuillez noter que le genre masculin est utilisé de façon générique dans les articles d'assistance pour en alléger le contenu.

III. L'API est une fonctionnalité avancée du produit et s'adresse généralement à vos équipes techniques (TI).

Introduction

Le portail Via HTML peut-être entièrement contrôlé par une interface externe ou un autre logiciel par API (wiki : Application Programming Interface). Vous pouvez consulter les guides API des différents produits de SVIeSolutions pour découvrir les appels API disponibles. Cette documentation évolue avec les produits et est maintenue à jour. Certains appels sont communs aux produits Lära LMS et Via HTML, qui par ailleurs peuvent être combinés.

Le présent article explique la mise en place de l'API sur votre portail Via HTML et non l'utilisation d'une interface API.

Capsule


Découvrir les avantages de l'API

La majorité des tâches administratives peuvent être aisément faites directement dans l'interface de votre portail Via HTML. Le portail permet même la création massive d'utilisateurs par importation en lot, ainsi que l'inscription massive de participants, aussi par importation en lot.
Malgré ces outils conviviaux et efficaces, certaines manoeuvres doivent être automatisées ou être effectuées sur trop d'objets du système pour qu'un humain effectue la tâche. C'est là où intervient l'API : il est possible de permettre à un autre système de maintenir à jour les dossiers des utilisateurs, par exemple, ou de maintenir à jour votre offre de formation.
Comme présenté en introduction, vous pouvez consulter les guides API des différents produits de SVIeSolutions pour découvrir les appels API disponibles. Vous devez ajouter une API et autoriser votre adresse IP ou celle de votre serveur avant de vous lancer dans les appels.

Ajouter une API sur le portail Via HTML

Pour ajouter une nouvelle API et vous autoriser à contrôler votre portail Via HTML, rendez-vous dans les « Réglages avancés » du menu « Administration », puis sous l'onglet « API ». À partir de cet endroit, vous pourrez consulter la liste des API existantes et leur type d'accès.
Pour ajouter une nouvelle API, appuyez sur « Ajouter une API ».

La section « Gestion de l'API » de la page d'ajout d'une nouvelle API affiche tout d'abord des informations importantes :
  • URL de l'API de Via : adresse à laquelle passer les appels API;
  • Votre clé de l'API (ApiID) : sert à identifier votre nouvelle API et votre environnement de portail Via HTML;
  • Votre adresse IP est : indique votre adresse IP actuelle. Vous en aurez besoin pour vous autoriser l'accès à la prochaine étape, si besoin est.
  • Nom * : donnez un nom administratif à votre nouvelle API pour l'identifier sur le portail Via HTML;
  • Type : définissez les droits d'accès pour cette API. 
Pour vous autoriser ou autoriser votre serveur à utiliser votre nouvelle API, cliquez sur « Ajouter une adresse IP ». Définissez les adresses IP ou les plages d'adresses IP qui sont autorisées à contrôler votre portail Via HTML.

ATTENTION : Vous pouvez ajouter une vaste plage d'adresses, et même ouvrir l'accès complet à l'aide d'astérisques (indique que n'importe quelle valeur est admise). Cela peut causer des problèmes de sécurité : veuillez vous assurer de resteindre les accès le plus possible, selon le contexte.


N'oubliez pas d'enregistrer vos modifications.

Cette réponse a-t-elle été utile ? Oui Non

Envoyer vos commentaires
Nous sommes désolés de ne pas avoir pu répondre à votre question. Aidez-nous à améliorer cet article grâce à vos commentaires.