A API da Amenitiz permite que outro sistema se ligue à sua conta Amenitiz e leia os dados da sua propriedade: os seus quartos, tarifas, disponibilidade, reservas e faturas.
Utilize-a se quiser ligar a Amenitiz a uma ferramenta externa, ou se um programador estiver a criar uma integração para a sua propriedade. A configuração é um trabalho técnico: o utilizador ou um programador que trabalhe consigo terão de escrever código.
Antes de começar
A API da Amenitiz está em beta e ainda está a ser disponibilizada, pelo que alguns detalhes podem mudar.
A API está disponível apenas no plano Advanced, e só o proprietário da conta pode criar ou gerir credenciais de API. Os membros da equipa não podem.
O que a API pode ler
Ao criar uma credencial, escolhe o que ela pode ler, entre seis áreas:
Tipos de quarto e quartos
Tarifas e ofertas
Calendário de disponibilidade
Reservas e dados dos hóspedes
Contas, faturas e pagamentos recebidos
Definições da propriedade e equipa
As três últimas incluem dados pessoais e sensíveis, por isso assinale-as apenas quando a ferramenta precisar mesmo delas.
O que a API não pode fazer
Não pode alterar nada na sua conta. A API apenas lê dados. As tarifas, a disponibilidade, as reservas e as definições alteram-se na Amenitiz.
Não abrange tudo o que vê na Amenitiz. Alguns dados só estão disponíveis na plataforma.
A Amenitiz não presta apoio técnico para implementações da API. É uma integração avançada disponibilizada em regime de autosserviço.
Passo a passo
Para começar:
Confirme que a sua propriedade está no plano Advanced e que é o proprietário da conta.
Crie as suas credenciais de API em
Definições→Credenciais de API. A Amenitiz gera um Client ID e um segredo.Entregue o Client ID e o segredo ao seu programador, ou cole-os na ferramenta que está a ligar.
Indique ao seu programador a documentação técnica em developers.amenitiz.com.
Este vídeo mostra o processo passo a passo:
📌 Nota
Pronto para ligar uma ferramenta? Consulte Como criar e gerir as suas credenciais de API.
Preciso de um programador para usar a API?
Preciso de um programador para usar a API?
Na maioria dos casos, sim. A API é uma interface técnica: ou trabalha com um programador, ou a ferramenta que está a ligar já é compatível com a API da Amenitiz. Para criar as credenciais, porém, não precisa de ninguém.
A API pode alterar as minhas tarifas, disponibilidade ou reservas?
A API pode alterar as minhas tarifas, disponibilidade ou reservas?
Não. A API apenas lê dados. Qualquer alteração às suas tarifas, disponibilidade, reservas ou definições tem de ser feita na Amenitiz.
Qual é a diferença entre a API e o Marketplace?
Qual é a diferença entre a API e o Marketplace?
O Marketplace reúne ligações já preparadas a ferramentas com que a Amenitiz já trabalha, e é o utilizador que as ativa, sem programar. A API serve para ligar uma ferramenta que não tem uma ligação preparada, e exige trabalho de desenvolvimento.
Estou no plano Advanced mas não vejo Credenciais de API
Estou no plano Advanced mas não vejo Credenciais de API
A API ainda está a ser disponibilizada, pelo que pode ainda não ter chegado à sua conta. Confirme que tem sessão iniciada como proprietário da conta e contacte a nossa equipa de apoio.