Ir para conteúdo principal

API: o que é, quando precisas e como solicitá-la

API | Integração personalizada | Motor de reservas próprio | PMS | CRM

Adriana Silva avatar
Escrito por Adriana Silva
Atualizado há mais de uma semana

O que é uma API?

Uma API (Application Programming Interface) é um intermediário que permite que dois sistemas comuniquem entre si. Em outras palavras, possibilita que uma aplicação solicite dados ou realize ações específicas numa outra, permitindo que ambas trabalhem em conjunto.

O seu objetivo é simples: conectar aplicações para trocar informações de forma segura e automatizada.


Quando posso precisar de uma API?

Geralmente, não é imprescindível usar uma API. A AvaiBook já disponibiliza um motor de reservas personalizável e adaptável ao teu site ou redes sociais, sem necessidade de programação.

No entanto, a API pode ser necessária se tiver:

  • Um software próprio de gestão ou faturação.

  • Um PMS ou CRM específico.

  • Um motor de reservas próprio.

  • Ou qualquer ferramenta interna que precise de ligar à AvaiBook para trocar dados.


Como se realiza a integração através da API?

A AvaiBook fornecerá ao seu programador uma API Key, com a qual poderá aceder seguramente à sua conta e programar a comunicação entre ambas as plataformas.
Além disso, disponibilizaremos previamente a documentação técnica necessária, onde se detalha que informação pode ser trocada e como fazê-lo corretamente, garantindo que a integração ocorra sem problemas.

  1. Geração da API Key

    A AvaiBook fornecerá ao seu programador uma API Key, que servirá como credencial de acesso à sua conta para programar a comunicação entre as plataformas.

  2. Documentação técnica

    Antes de iniciar, a AvaiBook fornece a documentação necessária para o programador saber que informação pode ser trocada e como fazê-lo corretamente.

  3. Ambiente de testes

    Após validar a viabilidade da integração, daremos acesso ao seu técnico ao nosso ambiente de testes, onde poderá iniciar a conexão e realizar os testes necessários.

  4. Certificação e ativação

    Uma vez concluídos os testes, a equipa técnica da AvaiBook certificará a integração e ativará a API na conta real.


Como posso solicitar a API?

Preenche o formulário disponível na sua conta:
Integrações > API > Formulário

A nossa equipa irá rever o seu pedido e confirmar se a integração é viável.
Após validada, será disponibilizado o acesso a um ambiente de testes para o seu programador poder iniciar o desenvolvimento.
Por fim, quando os testes estiverem concluídos, será realizada a certificação técnica e a integração será ativada na sua conta real.

Importante:

  • Requisito: utilizar a API requer um Plano Pro.

  • Não válida para integrações externas padrão: esta API não deve ser usada para conectar portais, fechaduras inteligentes ou outras aplicações externas. Nesses casos, a AvaiBook já oferece integrações desenvolvidas com partners e portais oficiais.

  • Desenvolvimento personalizado: a AvaiBook não desenvolve a integração. A nossa função é fornecer a API Key e a documentação técnica. A implementação deve ser realizada pela sua própria equipa informática.

Com a API da AvaiBook, poderá personalizar ainda mais a gestão do seu negócio, conectando as suas próprias ferramentas de forma segura e eficaz.


Aceda às nossas formações gravadas🎥
Aprende ao seu ritmo e a partir de qualquer lugar. Junte-se a nós para crescermos juntos!

Isto respondeu à sua pergunta?