Vizito dispose d’une API REST que vos propres systèmes peuvent utiliser pour lire et écrire des données visiteurs. Sa documentation complète se trouve sur un site dédié : developers.vizito.eu.
Que contient le portail développeurs ?
- Démarrage rapide : de l’absence d’identifiant à votre première liste de visiteurs en quelques minutes.
- Concepts de base : la poignée d’objets sur lesquels repose toute l’API, et la façon dont emplacements, visites et types de visite s’articulent.
- Référence de l’API : chaque point de terminaison, par ressource. Visiteurs, visiteurs enregistrés, hôtes, types de visite, points d’entrée, accords, appareils, reporting et WebHooks, chacun avec ses paramètres, un exemple de requête et un exemple de réponse.
- Guides : enregistrer les arrivées et les départs depuis votre propre système, préenregistrer des visiteurs et envoyer des invitations, synchroniser les hôtes avec votre annuaire, et recevoir des WebHooks.
De quoi ai-je besoin avant le premier appel ?
D’une clé API. Seuls les administrateurs globaux peuvent en créer une, depuis la page Intégrations du backoffice. Pour créer, restreindre et révoquer une clé, ou pour vous authentifier plutôt avec une application Microsoft Entra ID, voyez Accès API et clés API.
L’URL de base, les conventions valables pour tous les points de terminaison (identifiants, dates, champs personnalisés, langues) et la signification de chaque code d’erreur figurent sur la page Introduction.
Existe-t-il une spécification OpenAPI ?
Oui. La spécification est publiée sur vizito.eu/openapi.yaml : vous pouvez ainsi générer un client, importer l’API dans Postman ou Insomnia, ou brancher vos propres outils dessus.
Vizito peut-il nous notifier au lieu que nous interrogions l’API ?
Oui, avec un WebHook. Vizito appelle votre point de terminaison au moment même où quelque chose se produit : vous n’avez donc pas à demander sans cesse si quelque chose a changé. Pour la mise en place, voyez WebHooks dans ce centre d’aide, et pour les données transmises et les évènements, le guide Webhooks du portail développeurs.
À qui pouvons-nous poser nos questions sur l’API ?
Si un point de la documentation n’est pas clair ou si un point de terminaison ne se comporte pas comme décrit, contactez-nous. Précisez le point de terminaison, la requête envoyée et la réponse obtenue.