O que é a API aberta?
A Open API da Stays é uma interface que permite a integração de funcionalidades com outras plataformas. Com ela, desenvolvedores podem criar soluções customizadas para o seu próprio sistema.
Como ativar a API Stays?
Vá em [App Center > Stays API > API Externo], selecione [Ativo] e clique no botão de salvar. Você verá suas credenciais de acesso depois de ativar.
Como funciona a cobrança da API?
A cobrança é de R$ 95 por mês. Este valor será automaticamente incluído na sua fatura e cobrado mensalmente enquanto a API estiver ativada no seu sistema. É possível desativá-la a qualquer momento.
A Stays tem parceria com algum desenvolvedor para a API?
Não temos nenhuma parceria. Você pode contratar um desenvolvedor por conta própria e enviar a nossa documentação completa para ele checar todas as informações.
O que eu posso fazer com a API?
Confira alguns exemplos de uso dos endpoints disponíveis na nossa API.
Verifica a possibilidade de reserva e retorna o link para que o hóspede conclua a reserva. O hóspede será criado dentro do sistema Stays se ele não existir.
- Costuma ser usado para que apps externos criem reservas pelo site. Nesse caso, os dados da reserva chegam na Stays com o nome do parceiro (app externo) que gerou a reserva.
Permite criar, gerenciar e ler os códigos promocionais do sistema
- Normalmente usado para campanhas de marketing. Ao combiná-lo com endpoints de hóspede, por exemplo, você pode automatizar processos de criação de cupons para aniversariantes.
Permite pesquisar os anúncios disponíveis, calcular o preço de determinado anúncio, gerenciar reservas e clientes.
- Costuma ser usado para gerenciar reservas externamente, como em aplicativos ou páginas web externas. Com a API, é possível criar uma aplicação que permite o gerenciamento de reservas por parte de terceiros (hóspedes ou colaboradores), sejam elas já existentes ou novas reservas (endpoint de criação de reserva).
Permite gerenciar contas bancárias para pagamentos no website e ler os registros presentes no balanço de proprietários.
- Normalmente usado para integrar as informações bancárias em aplicações externas. Importante: não há vínculo interbancário, ou seja, as transações bancárias não acontecem por meio da Stays. A integração funciona da mesma forma que o nosso sistema, apenas para registro e validação de pagamentos.
- Também é possível usar para integrar os dados dos balanços de cada proprietário e, com isso, criar soluções personalizadas.
Obtém informações sobre disponibilidade, preços e restrições para determinado período. Permite atualizar preços e restrições.
- Pode ser usado para espelhar a tela de calendário geral em um sistema de gerenciamento externo, como a PriceLabs.
Permite gerenciar as regras de precificação por temporada.
- Funciona de forma semelhante ao módulo de calendário de acomodações. O de calendário é usado para o modelo de precificação por noite, enquanto o de preços é para o modelo de precificação por período.
- Normalmente usado para gerenciamento externo de temporadas e eventos.
Retorna, gerencia e cria informações relacionadas aos conteúdos das propriedades e acomodações criadas no sistema. Pode ser usado para gerenciar conteúdo descritivo, quartos e grupos.
- Costuma ser usado para gerenciar o conteúdo externamente e também para criar páginas ou aplicativos externos que precisam ser alimentados com o conteúdo do sistema, como aplicativo para hóspedes.
Contempla apenas a funcionalidade de campos personalizados do sistema. São quatro endpoints para ler, criar, editar e deletar os campos personalizados do sistema.
- Pode ser usado para diversas operações. A mais comum é aproveitar o campo personalizado para comunicar o hóspede sobre alguma informação da acomodação, como a senha do Wi-Fi ou voltagem da tomada, por exemplo.
Campos personalizados externos
Usado para personalizar a experiência do sistema. Com ele, é possível gerenciar campos personalizados que serão incluídos externamente em sites e aplicativos, por exemplo.
- Se precisar de um campo personalizado não incluso no sistema, pode usar este endpoint para incluir campos em um formulário de cadastro para uma aplicação ou site externo, por exemplo.
Usado para leitura de configurações de preço, disponibilidade e regras da casa. Também é possível usar para alterar os parâmetros de regras da casa.
- Geralmente usado para gerar filtros de busca externos e também para gerar informações sobre as acomodações em uma página externa.
Usado para o sistema disparar notificações quando algo é alterado.
- Clientes costumam usar para lógicas de criação de reserva. Quando uma reserva é criada no sistema, podemos enviar um webhook para que essa reserva seja também criada em um calendário externo.
- É possível criar diversas automações de alteração com os webhooks que temos na documentação.