Qu’est-ce qu’une API
L’intégration entre plusieurs systèmes d’information est essentielle. Sans elle une foule d’opérations manuelles de ressaisies de données viennent consommer du temps et éparpiller l’information. C’est pourquoi il faut permettre aux application de communiquer directement entre elles de façon automatisée. Le présent article décrit comment vous pouvez rendre votre application capable de communiquer avec WEHOOP. En particulier vous apprendrez comment rechercher des données et créer des formulaires dans WEHOOP de manière automatisée ou si vous préférez, par programmation. On nomme généralement la technologie utilisée pour intégrer des systèmes d’informations une API ou Interface de Programmation.
Ce que l’on peut faire avec l’API
- Il est possible en utilisant l’API de rechercher des données contenues dans WEHOOP. Un vaste éventail d’informations utiles peuvent être extraites et réutilisées par votre application. Parmi celles-ci on peut compter les coordonnées des utilisateurs, les processus et formulaires auxquels il a accès, l’historique, les approbations, les accès, etc..
- Vous pouvez aussi créer des formulaires. Les formulaires de WEHOOP sont plus que de simples formulaires. Ils se déploient rapidement, peuvent être supportés par un processus ou une gestion des accès, présentent une interface moderne (lire adaptative) et supportent les principaux navigateurs et appareils mobiles. Pour ces raisons, il est avantageux de laisser à WEHOOP, le soin de vos formulaires. En créant des nouveaux formulaires par l’API vous pourrez aussi spécifier des valeurs initiales pour les champs et les personnes qui devront les compléter.
- Il existe aussi un mode avancé permettant de faire toutes les actions accessibles depuis l’interface de WEHOOP. Comme par exemple: transférer, réassigner, partager, annuler, etc..
Fonctionnement de l’API
L’API s’authentifie d’abord par un POST HTTP envoyé au serveur WEHOOP avec les trois (3) paramètres suivants: URL, Username et Password. Il faut utiliser le protocole HTTPS dans l’URL de connection.
Lorsque le Username et Password sont validés, un cookie LtpaToken est retourné et conservé par l’API. Chacune des requêtes subséquentes seront automatiquement accompagnées du cookie.
Ces requêtes sont des appels utilisant le protocole HTTPS. Les données sont envoyés sous forme de POST contenant un objet sérialisé en JSON. (voir json.org) Cette API est de type REST.
*Notez que l’utilisation de l’API est réservée exclusivement aux utilisateurs du groupe API.
Utilisation de l’API
L’API est disponible pour deux langages de programmation et d’autres pourront s’ajouter à la demande. Ces langages sont .NET et Java. Les méthodes des API sont documentées, ils suffit des les inclure dans vos projets sous Eclipse, Visual Studio, etc.. Les méthodes sont les même peut importe le langage utilisé.
COMMENT FAIRE?
- Instancier un objet de type Hoop.
- Appeler la méthode « connect » sur l’instance.
- Appeler la méthode « search » ou « create »
Quelques exemples
Voici un exemple pour démarrer un processus dont l’ID est « C826B0EBD46FBA16852579B50071DB4E ».
Langage Java
Hoop hoop = new Hoop();
hoop.connect("https://hoop.kiwi.ca", "*****", "*********");
JSONObject hoopForm = hoop.create("C826B0EBD46FBA16852579B50071DB4A");
System.out.println(hoopForm.toString()); // imprime en console sous format JSON l'ensemble des valeurs du formulaire
Langage C#
Hoop hoop = new Hoop();
hoop.connect("https://hoop.kiwi.ca", "*****", "*********");
JObject hoopForm = hoop.create("C826B0EBD46FBA16852579B50071DB4A");
Console.Write(hoopForm.ToString()); // imprime en console sous format JSON l'ensemble des valeurs du formulaire
Contactez-nous
Pour obtenir la dernière version de l’API WEHOOP, communiquez avec nous au 1-855-274-1118 et demandez à parler avec notre équipe de support.