Utilisation de l'API ouverte de Guesty

L'API ouverte de Guesty est une API REST offrant une solution polyvalente pour intégrer vos 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 qui assure un accès sécurisé aux données utilisateur grâce à des jetons chiffrés, sans exposer l'identité ni les informations d'identification de l'utilisateur. Pour plus d'informations, consultez notre documentation API et les détails relatifs aux limites de débit des appels API de Guesty.

L'API ouverte de Guesty vous permet, ainsi qu'à votre équipe, d'intégrer les informations d'authentification de votre application à vos services, outils ou systèmes. 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 recevez un identifiant client et un secret client, qui peuvent être utilisés lors d'appels API nécessitant l'identification de l'application.

Pas à pas :

1. Connectez-vous à votre compte Guesty.
2. En haut à droite, cliquez et sélectionnez API ouverte.
3. Dans le menu de gauche, cliquez sur Applications (cette option devrait déjà être sélectionnée par défaut).
4. En haut à droite, cliquez sur Nouvelle application.
5. Saisissez le nom et la description de l'application, puis cliquez sur Enregistrer. Ces champs sont obligatoires.

6. Cliquez à côté de la clé correspondante et collez-la dans un endroit sûr pour consultation ultérieure.

   Important :

   Votre identifiant client et votre secret client ne sont visibles que lors du premier accès, après quoi Guesty les masque pour des raisons de sécurité.

Supprimer la paire de clés API

Pour supprimer une application, ainsi que son identifiant 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 analytique de l'API ouverte de Guesty

Le tableau de bord analytique de l'API ouverte de Guesty offre une vue d'ensemble détaillée de l'utilisation et des performances de l'API de votre application. Cet outil vous permet de suivre des indicateurs clés tels que les taux de réussite des requêtes, les erreurs client et les seuils de limite de débit. Chaque section du tableau de bord fournit des informations précieuses, vous aidant à 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 de l'API ouverte de Guesty.

Pas à pas :

1. Connectez-vous à votre compte Guesty.
2. En haut à droite, cliquez et sélectionnez Open API.
3. Dans le menu de gauche, cliquez sur Données analytiques.

En savoir plus sur les différentes 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
• État de la réponse
• Résolution de la réponse
• Famille d'URL
• modèle d'URL
• Hôte
• Méthode
• ID Voyageur
• Nom du voyageur
• Passerelle
• Type de serveur

Demandes générales

Utilisez le graphique des requêtes générales pour visualiser les appels d'Open API suivants pour toutes les applications :

• Appels réussis
• Échec des appels en raison d'une erreur du voyageur
• Les appels ont échoué en raison d'une erreur du serveur.

Limite de tarif

Utilisez le graphique de la limite de tarif pour visualiser le nombre de limites de tarif restantes pour chaque application, comme suit :

• Appels restants par heure avant la limite de tarif
• Appels restants par minute avant la limite de tarif
• Appels restants par seconde avant 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 voyageurs

Reportez-vous aux lignes colorées du graphique pour identifier les appels d'Open API de chaque application associée à votre compte.

Utilisation des webhooks côté client de Guesty

La section des webhooks de Guesty offre une interface centralisée pour gérer les webhooks, visualiser l'activité et résoudre efficacement les problèmes.

Points d'extrémité

Surveillez régulièrement les points de terminaison pour garantir un faible taux d'erreur et résoudre rapidement tout problème. Consultez et gérez toutes les URL de webhook actives et leurs taux d'erreur respectifs. Le taux d'erreur reflète le succès des envois de webhook.

• 0 % indique que tous les webhooks ont été correctement acheminé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.

Consulter les journaux pour une URL spécifique

Utilisez les journaux de webhook pour un point de terminaison d'URL spécifique afin d'isoler les problèmes liés à ce point de terminaison.

page d'activité des webhooks d'URL de point de terminaison

Cliquez sur une URL de 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 auxquels vous êtes inscrit

  • Signature secrète

    La clé utilisée pour authentifier les requêtes de Guesty vers votre point de terminaison.

  • Rejouer les événements

    Pour rejouer des événements webhook individuels, cliquez à côté de l'événement concerné, sélectionnez l'action appropriée dans la fenêtre contextuelle et cliquez sur Renvoyer .

  • Filtres

    Utilisez les filtres pour affiner les résultats :

    Filtrez par Tous, Réussis ou Échecs ou cliquez sur Filtres pour filtrer par types d'événement, étiquettes ou dates.

  • Journaux

    Cliquez sur le type d'événement correspondant pour afficher la charge utile d'une URL spécifique.

• Avancé : Actuellement réservé à la consultation.
• Test : Actuellement réservé à la consultation.

Catalogue des types d'événements

Affiche la liste de tous les types d'événements Guesty. Cliquez sur un type d'événement pour afficher son schéma.

Journaux

Utilisez les journaux pour obtenir une vue d'ensemble de toutes les activités des webhooks afin de repérer les tendances ou les problèmes potentiels à l'échelle du système, idéal pour identifier des schémas ou examiner l'activité récente quel que soit le point de terminaison.

Vous pouvez consulter les journaux d'un point de terminaison URL spécifique pour isoler les problèmes liés à ce 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 tous les journaux de messages des points de terminaison abonnés. Cette fonctionnalité est utile pour diagnostiquer un problème plus général affectant plusieurs points de terminaison.

Vous pouvez également filtrer par type d'événement, ou cliquer sur Aller au message, saisir un ID de message/d'événement et cliquer sur Aller pour localiser un événement spécifique.

Activité

Affiche une représentation visuelle des performances des webhooks au cours des six dernières heures, afin d'obtenir des informations en temps réel sur ces performances et de prendre des mesures proactives si nécessaire.

Consultez le nombre de tentatives de livraison de webhook réussies et échouées afin d'identifier rapidement toute augmentation soudaine du nombre d'échecs ou autre anomalie.