API Open de Guesty est une API REST offrant une solution polyvalente pour intégrer vos propres systèmes à votre compte Guesty. Elle utilise des jetons d'accès OAuth 2.0 pour authentifier les requêtes, garantissant ainsi une autorisation sécurisée et fiable. OAuth 2.0 est une méthode d'autorisation sécurisée et standard du secteur qui garantit l'accès sécurisé aux données utilisateur grâce à des jetons codés, sans exposer l'identité ni les informations d'authentification de l'utilisateur. Pour plus d'informations, consultez la documentation de notre API et les détails sur les limites de tarif d'appels de l'API Guesty.
L'API ouverte de Guesty vous permet, à vous et à votre équipe, de créer et de connecter des outils personnalisés adaptés à vos besoins. Vous pouvez générer des identifiants et des secrets clients uniques (informations d'authentification client) pour chaque service, outil ou système intégré. De plus, nos données analytiques fournissent des données en temps réel sur l'utilisation de votre API, vous aidant ainsi à surveiller et à optimiser vos intégrations.
Suivez les instructions ci-dessous pour enregistrer une nouvelle application. Vous pouvez la supprimer à tout moment.
Créer une paire de clés API
Lorsque vous enregistrez une application, vous recevrez un identifiant client et un secret client, qui peuvent être utilisés lors d'appels API nécessitant une identification d'application.
Pas à pas :
- Connectez-vous à votre compte Guesty.
En haut à droite, cliquez 
et sélectionnez Ouvrir API.
- Dans le menu de gauche, cliquez sur Applications (cela devrait déjà être sélectionné par défaut).
- En haut à droite, cliquez sur Nouvelle application.
- Saisissez le nom et la description de l'application, puis cliquez sur Enregistrer. Ces champs sont obligatoires.
- Cliquez
à côté de la clé concernée et collez-la dans un endroit sécurisé pour référence ultérieure.
Important :
Votre identifiant client et votre secret client ne sont visibles que la première fois que vous y accédez, après quoi Guesty les expurge pour votre sécurité.
Supprimer la paire de clés API
Pour supprimer une application, ainsi que son ID client et son secret client, cliquez sur 
à droite de l'application concernée et confirmez l'action dans la fenêtre contextuelle. Cette action est irréversible.
Utilisation du tableau de bord des données analytiques Open API de Guesty
Le tableau de bord des données analytiques Open API de Guesty est conçu pour fournir une vue d'ensemble détaillée de l'utilisation et des performances des API de votre application. Cet outil vous permet de surveiller des indicateurs clés tels que le taux de réussite des requêtes, les erreurs client et les seuils de limite de tarif. Chaque section du tableau de bord offre des informations précieuses pour vous aider à optimiser les appels API, à résoudre les problèmes et à garantir une intégration fluide avec les applications tierces.
Suivez les instructions pour accéder au tableau de bord Open API de Guesty.
Pas à pas :
- Connectez-vous à votre compte Guesty.
En haut à droite, cliquez et sélectionnez Ouvrir API.
- Dans le menu de gauche, cliquez sur Données analytiques.
En savoir plus sur les sections du tableau de bord ci-dessous.
Filtres
Cliquez sur le signe plus pour appliquer les filtres suivants à l’ensemble du tableau de bord :
- Laps de temps
- Statut de la réponse
- Résolution de réponse
- Famille d'URL
- Modèle d'URL
- Hôte
- Méthode
- ID client
- Nom du client
- Passerelle continue
- Type de serveur
Conseil :
Pour filtrer par point de terminaison, cliquez sur le point de terminaison concerné dans le tableau des modèles d'URL.
Demandes générales
Utilisez le graphique des demandes générales pour afficher les appels API Open suivants pour toutes les applications :
- Appels réussis
- Appels échoués en raison d'une erreur client
- Échecs des appels en raison d'une erreur de serveur
Limite de tarif
Utilisez le graphique de limite de tarif pour afficher la quantité restante de limites de tarif pour chaque application comme suit :
- Appels restants par heure jusqu'à la limite de tarif
- Appels restants par minute jusqu'à la limite de tarif
- Appels restants par seconde jusqu'à la limite de tarif
Modèle d'URL
Le tableau affiche les éléments suivants par ordre décroissant :
- Modèle d'URL - le point de terminaison qui a été appelé
- Nombre d'événements - le nombre d'appels effectués
Demandes des clients
Reportez-vous aux lignes colorées sur le graphique pour identifier les appels Open API pour chaque application sous votre compte.
Utilisation des webhooks orientés client de Guesty
La section dédiée aux webhooks de Guesty offre une interface centralisée pour gérer les webhooks, visualiser l'activité et résoudre efficacement les problèmes. Consultez la documentation officielle des webhooks de Guesty pour plus d'informations.
Points de terminaison
Surveillez régulièrement les points de terminaison pour garantir un faible taux d'erreur et résoudre rapidement les problèmes. Consultez et gérez toutes les URL de webhooks actives et leurs taux d'erreur respectifs. Le taux d'erreur reflète la réussite des livraisons de webhooks :
- 0 % indique que tous les webhooks sont livrés avec succès.
- Un taux d'erreur sur une URL active indique des problèmes de livraison qui peuvent nécessiter une résolution de problèmes.
Afficher les journaux pour une URL spécifique
Utilisez les journaux webhook pour un point de terminaison d’URL spécifique afin d’isoler les problèmes liés au point de terminaison.
Page d'activité des webhooks d'URL de point de terminaison
Cliquez sur l'URL d'un webhook pour accéder à des informations détaillées, notamment les suivantes :
- Vue d'ensemble
- Date de création
- Date de la dernière mise à jour
- Événements souscrits
- Signature secrète
La clé utilisée pour authentifier les demandes de Guesty à votre point de terminaison.
- Événements en replay
Pour rejouer des événements webhook individuels, cliquez sur 
à côté de l'événement concerné, sélectionnez l'action appropriée dans la fenêtre contextuelle et cliquez sur Renvoyer.
- Filtres
Utilisez des filtres pour affiner les résultats :
Filtrez par Tout, Réussi ou Échec ou cliquez sur Filtres pour filtrer par Types d'événement, Balises ou Dates
- Journaux
Cliquez sur le type d'événement concerné pour afficher la charge utile d’une URL spécifique.
- Avancé : Actuellement à des fins de visualisation uniquement.
- Test : Actuellement à des fins de visualisation uniquement.
Catalogue d'événements
Affiche la liste de tous les types d'événements de Guesty. Cliquez sur le type d'événement pour afficher le schéma.
Journaux
Utilisez les journaux pour obtenir une vue d'ensemble de toutes les activités du webhook afin de repérer les tendances ou les problèmes potentiels à l'échelle du système, idéal pour identifier les modèles ou examiner l'activité récente quel que soit le point de terminaison.
Vous pouvez afficher les journaux d’un point de terminaison d’URL spécifique pour isoler les problèmes liés au point de terminaison.
Vous pouvez également cliquer sur un type d'événement pour afficher la charge utile d'une URL spécifique et consulter ainsi tous les journaux de messages des points de terminaison abonnés. Cela permet de diagnostiquer un problème plus large sur plusieurs points de terminaison.
Vous pouvez également filtrer par types d'événements ou cliquer sur Accéder au message, saisir un ID de message/événement et cliquer sur Aller pour localiser un événement spécifique.
Activité
Affiche une représentation visuelle des performances du webhook au cours des six dernières heures, pour obtenir des informations en temps réel sur les performances de votre webhook et prendre des mesures proactives si nécessaire.
Affichez le nombre de tentatives de livraison de webhook réussies et échouées pour identifier rapidement les pics d'échecs ou autres anomalies.