L'API aperta di Guesty è un'API REST che offre una soluzione versatile per integrare i tuoi sistemi con il tuo account Guesty. Utilizza token di accesso OAuth 2.0 per autenticare le richieste, garantendo un'autorizzazione sicura e affidabile. OAuth 2.0 è un metodo di autorizzazione sicuro e standard di settore che garantisce l'accesso sicuro ai dati utente utilizzando token codificati senza esporre l'identità o le credenziali dell'utente. Per ulteriori informazioni, consulta la nostra documentazione API e i dettagli sui limiti di frequenza delle chiamate API di Guesty.
L'API aperta di Guesty consente a te e al tuo team di creare e connettere strumenti personalizzati in base alle vostre esigenze. Puoi generare ID client e credenziali client (secret) univoci per ogni servizio, strumento o sistema che integri. Inoltre, le nostre statistiche forniscono dati in tempo reale sull'utilizzo dell'API, aiutandoti a monitorare e ottimizzare le tue integrazioni.
Segui le istruzioni qui sotto per registrare una nuova applicazione. Puoi eliminarla in qualsiasi momento.
Crea una coppia di chiavi API
Quando registri l'applicazione, riceverai un ID client e un segreto client, che possono essere utilizzati quando effettui chiamate API che richiedono l'identificazione dell'applicazione.
Passo dopo passo:
- Accedi al tuo account Guesty.
- In alto a destra, clicca
e seleziona Apri API. - Nel menu a sinistra, clicca su Applicazioni (questa opzione dovrebbe essere già selezionata per impostazione predefinita).
- In alto a destra, clicca su Nuova applicazione.
- Inserisci il nome e la descrizione dell'applicazione e clicca su Salva. Questi campi sono obbligatori.
-
Clicca
accanto alla chiave pertinente e incollalo in un posto sicuro per riferimento futuro.Importante:
Il tuo ID cliente e il tuo segreto cliente saranno visibili solo al primo accesso, dopodiché Guesty li nasconderà per motivi di sicurezza.
Elimina la coppia di chiavi API
Per eliminare **l'applicazione**, insieme al suo ID client e al suo segreto client, fare clic su 
a destra **dell'applicazione** in questione e confermare l'azione nel pop-up. Questa azione è irreversibile.
Utilizzo della dashboard **delle** statistiche Open API di Guesty
La dashboard **delle** statistiche API aperte di Guesty è progettata per fornire una panoramica dettagliata dell'utilizzo e delle prestazioni delle API della tua applicazione. Questo strumento consente di monitorare metriche chiave come percentuali di successo delle richieste, errori dei client e soglie limite **di** tariffa. Ogni sezione della dashboard offre informazioni preziose, aiutandoti a ottimizzare le chiamate API, risolvere i problemi e garantire **un'integrazione** fluida con applicazioni di terze parti.
Segui le istruzioni per accedere alla dashboard Open API di Guesty.
Passo dopo passo:
- Accedi al tuo account Guesty .
- In alto a destra clicca e seleziona Open API .
- Nel menu a sinistra, fare clic su Statistiche.
Di seguito **troverai** ulteriori informazioni sulle sezioni della dashboard.
Filtri
Fare clic sul segno più per **applicare** i seguenti filtri all'intera dashboard:
- Intervallo di tempo
- Stato della risposta
- Risoluzione della risposta
- Famiglia URL
- Modello URL
- Host
- Metodo
- ID cliente
- Nome del cliente
- Procedi al gateway
- Tipo di server
Suggerimento:
Per filtrare in base all'endpoint, fare clic sull'endpoint pertinente nella tabella Modello URL.
Richieste Generali
Utilizzare il grafico delle richieste generali per visualizzare le seguenti chiamate Open API per tutte le applicazioni:
- Chiamate di successo
- Chiamate non riuscite a causa di un errore del client
- Chiamate non riuscite a causa di un errore del server
Limiti di Tariffa
Utilizzare il grafico dei limiti di tariffa per visualizzare la quantità rimanente di chiamate rispetto ai limiti di tariffa per ciascuna applicazione, come segue:
- Chiamate rimanenti all'ora fino al limite di tariffa
- Chiamate rimanenti al minuto fino al limite di tariffa
- Chiamate rimanenti al secondo fino al limite di tariffa
Modello URL
Nella tabella sono visualizzati i seguenti dati in ordine decrescente:
- Modello URL: l'endpoint che è stato chiamato
- Numero di eventi: il numero di chiamate effettuate
Richieste dei clienti
Fai riferimento alle linee colorate sul grafico per identificare le chiamate Open API per ciascuna applicazione nel tuo account.
Utilizzo dei webhook rivolti al cliente di Guesty
La sezione webhook di Guesty fornisce un'interfaccia centralizzata per gestire i webhook, visualizzare l'attività e risolvere efficacemente i problemi.
Nota:
La dashboard dei webhook al momento non supporta la gestione delle sottoscrizioni ai webhook. È possibile sottoscrivere e gestire i webhook solo tramite l'Open API. Per gestire le sottoscrizioni ai webhook, consultare la guida API dei webhook.
Punti finali
Monitorare regolarmente gli endpoint per garantire bassi tassi di errore e risolvere tempestivamente eventuali problemi. Visualizzare e gestire tutti gli URL dei webhook attivi e i rispettivi tassi di errore. La tariffa di errore riflette il successo delle consegne dei webhook:
- 0% indica che tutti i webhook sono stati recapitati correttamente.
- Una tariffa di errore su un URL attivo indica problemi di recapito che potrebbero richiedere risoluzione dei problemi.
Visualizza i registri per un URL specifico
Utilizzare i log dei webhook per un endpoint URL specifico per isolare i problemi correlati all'endpoint.
pagina delle attività dei webhook dell'URL dell'endpoint
Fare clic su un URL webhook per accedere a informazioni dettagliate, tra cui:
- Panoramica
- data di creazione
- data dell'ultimo aggiornamento
- Eventi sottoscritti
-
Firma segreta
La chiave utilizzata per autenticare le richieste da Guesty al tuo endpoint.
-
Riproduci eventi
Per riprodurre singoli eventi webhook, fare clic su
accanto all'evento pertinente, seleziona l'azione pertinente nel pop-up e fai clic su Invia di nuovo . -
Filtri
Utilizza i filtri per restringere i risultati:
Filtra per Tutti, Riusciti o Non riusciti oppure fai clic su Filtri per filtrare per Tipi di evento, Tag o Date
-
Registri
Fare clic sul tipo di evento pertinente per visualizzare il payload di un URL specifico.
Catalogo Evento
Visualizza un elenco di tutti i tipi di evento di Guesty. Clicca sul tipo di evento per visualizzarne lo schema.
Registri
Utilizza i registri, ideali per identificare modelli o esaminare le attività recenti indipendentemente dall'endpoint, per una panoramica completa di tutte le attività del webhook e per individuare tendenze o potenziali problemi a livello di sistema.
È possibile visualizzare i registri per un endpoint URL specifico per isolare i problemi correlati all'endpoint.
In alternativa, fai clic su un tipo di evento per visualizzare il payload di un URL specifico e visualizzare tutti i log dei messaggi degli endpoint sottoscritti. Questa funzionalità è utile per diagnosticare un problema più ampio che interessa più endpoint.
Puoi anche filtrare per tipo di evento oppure fare clic su Vai al messaggio, immettere un ID messaggio/evento e fare clic su Vai per individuare un evento specifico.
Attività
Visualizza una rappresentazione visiva delle prestazioni del webhook nelle ultime sei ore, per ottenere informazioni in tempo reale sulle prestazioni del webhook e adottare misure proattive secondo necessità.
Visualizza il numero di tentativi di recapito dei webhook riusciti e non riusciti per identificare rapidamente eventuali picchi di errori o altre anomalie.
