A API aberta da Guesty é uma API REST que oferece uma maneira versátil de integrar seus sistemas à sua conta Guesty. Ela utiliza tokens de acesso OAuth 2.0 para autenticar solicitações, garantindo uma autorização segura e confiável. O OAuth 2.0 é um método de autorização seguro e padrão do setor que garante o acesso seguro aos dados do usuário por meio de tokens criptografados, sem expor a identidade ou as credenciais do usuário. Para mais informações, consulte nossa documentação da API e os detalhes sobre os limites de tarifa de chamadas da API da Guesty.
A API aberta da Guesty permite que você e sua equipe criem e conectem ferramentas personalizadas, adaptadas às suas necessidades. Você pode gerar IDs de cliente e segredos de cliente (credenciais de cliente) exclusivos para cada serviço, ferramenta ou sistema que integrar. Além disso, nossas análises fornecem dados em tempo real sobre o uso da sua API, ajudando você a monitorar e otimizar suas integrações.
Siga as instruções abaixo para registrar um novo aplicativo. Você pode excluí-lo a qualquer momento.
Observação:
Você pode criar até cinco (5) aplicativos Open API OAuth.
Criar credenciais OAuth
Ao registrar um aplicativo, você receberá um ID do cliente e um segredo do cliente, que podem ser usados ao fazer chamadas de API que exigem a identificação do aplicativo.
Passo a passo:
- Faça login na sua conta Guesty.
- No menu de navegação lateral, clique em
Integrações para abrir o menu suspenso e selecionar Ferramentas de desenvolvedor. - Selecione aplicativos OAuth.
- No canto superior direito, clique em Novo aplicativo.
- Insira o nome e a descrição do aplicativo e clique em Salvar. Esses campos são obrigatórios.
-
Clique
ao lado da chave correspondente, cole-a em um local seguro para referência futura.Importante:
A sua chave secreta só fica visível no primeiro acesso, depois disso o Guesty a oculta para sua segurança.
Excluir par de chaves de API
Para excluir um aplicativo, juntamente com seu ID do cliente e segredo do cliente, clique em 
à direita do aplicativo correspondente. Confirme a ação na janela pop-up. Esta ação é irreversível.
Usando o painel de análise da API aberta da Guesty
O painel de análise de API aberta da Guesty oferece uma visão geral detalhada do uso e desempenho da API do seu aplicativo. Essa ferramenta permite monitorar métricas importantes, como taxas de sucesso de solicitações, erros do cliente e limites de tarifa. Cada seção do painel oferece informações valiosas para ajudar você a otimizar chamadas de API, solucionar problemas e garantir uma integração perfeita com aplicativos de terceiros.
Siga as instruções para acessar o painel da API aberta da Guesty.
Passo a passo:
- Faça login na sua conta Guesty.
- No menu de navegação lateral, clique em Integrações para abrir o menu suspenso.
- Selecione Análise OAuth.
Utilizando os webhooks voltados para o cliente do Guesty
A seção de webhooks do Guesty fornece uma interface centralizada para gerenciar webhooks, visualizar atividades e solucionar problemas de forma eficaz.
Observação:
O painel de controle de webhooks não suporta a gestão de assinaturas de webhooks no momento. Você pode assinar e gerenciar webhooks somente por meio da API aberta. Para gerenciar assinaturas de webhooks, consulte o guia da API de webhooks.
Pontos finais
Monitore regularmente os endpoints para garantir baixas taxas de erro e resolva quaisquer problemas prontamente. Visualize e gerencie todos os URLs de webhook ativos e suas respectivas taxas de erro.
Visualizar registros para um URL específico
Clique em um URL de webhook para acessar informações detalhadas, incluindo o segredo de assinatura (a chave usada para autenticar solicitações do Guesty para o seu endpoint) e a possibilidade de reproduzir eventos individuais do webhook.