As credenciais de API são como um nome de utilizador e uma palavra-passe que permitem que outro sistema se ligue à sua conta Amenitiz e leia os dados da sua propriedade, como os seus quartos, tarifas, disponibilidade, reservas e faturas. Uma credencial apenas lê: nada do que ligar desta forma pode alterar seja o que for na Amenitiz.

Utilize-as se quiser ligar a Amenitiz a uma ferramenta externa, ou se um programador estiver a criar uma integração para a sua propriedade. Novo na API? Comece por Como compreender a API da Amenitiz.

Antes de começar

A API da Amenitiz está em beta e ainda está a ser disponibilizada, pelo que alguns detalhes podem mudar.

Para criar credenciais de API, tem de estar no plano Advanced e ser o proprietário da conta. Os membros da equipa não podem criar nem gerir credenciais.

Tenha a sua palavra-passe da Amenitiz à mão: vai ser-lhe pedida para terminar.

Passo a passo

Vá a Definições.
Abra Credenciais de API.
Clique em Nova credencial.
Dê-lhe um nome que reconheça mais tarde, por exemplo a ferramenta que está a ligar, como "Exportação contabilística".
Em O que é que ela pode ler?, assinale apenas o que a ferramenta lhe pediu — tem de assinalar pelo menos uma coisa. Pode alterar isto mais tarde.
Se tiver mais do que uma propriedade, assinale quais é que a credencial abrange em Quais propriedades?. Com uma só propriedade, não há nada a escolher.
Clique em Criar credencial.
Introduza a sua palavra-passe da Amenitiz quando aparecer Confirmar que é você e clique novamente em Criar credencial.
Copie o Client ID e o segredo, ou clique em Transferir como ficheiro para os guardar.
Clique em Concluído.

📌 Nota

Não há nada para memorizar. Se perder o segredo, abra novamente a credencial e a Amenitiz mostra-lho depois de verificar a sua palavra-passe.

Já pode entregar o Client ID e o segredo ao seu programador, ou colá-los na ferramenta que está a ligar.

Escolher o que uma credencial pode ler

Uma credencial só lê o que assinalar, por isso assinale apenas o que a ferramenta lhe pediu. As seis opções são:

Tipos de quarto e quartos: os dados da sua propriedade, os seus tipos de quarto e os quartos individuais que os compõem.
Tarifas e ofertas: planos tarifários, extras, promoções e condições de venda.
Calendário de disponibilidade: dia a dia, o que está livre, o preço e qualquer estadia mínima.
Reservas e dados dos hóspedes: reservas, cobranças e pagamentos, incluindo o nome, e-mail, telefone e morada de cada hóspede, e tudo o que tenham escrito nos seus pedidos.
Contas, faturas e pagamentos recebidos: as contas, faturas e notas de crédito que emitiu, incluindo os dados de faturação dos seus clientes, e a sua conta de pagamentos recebidos.
Definições da propriedade e equipa: horários de check-in, e-mails automatizados, e os nomes, e-mails e permissões da sua equipa.

🚫 Aviso

As três últimas opções abrangem dados pessoais e sensíveis. Os seus hóspedes nunca concordaram em partilhar os seus dados com a ferramenta que está a ligar: está a decidir por eles. Assinale Reservas e dados dos hóspedes, Contas, faturas e pagamentos recebidos e Definições da propriedade e equipa apenas quando a ferramenta precisar mesmo deles.

Gerir as suas credenciais

Ao abrir uma credencial, pode:

Copiar o Client ID.
Mostrar o segredo para o ver outra vez, e Ocultar quando terminar.
Substituir o segredo por um novo. Faça-o se achar que o seu segredo foi partilhado ou divulgado. O Client ID mantém-se igual, só o segredo muda, e qualquer ferramenta que ainda use o segredo antigo perde o acesso até lá colar o novo.
Revogar a credencial para a desativar de forma permanente. A Amenitiz pede-lhe que escreva o nome da credencial para confirmar e, a partir daí, qualquer ferramenta que a utilize perde o acesso de imediato.
Alterar o que a credencial pode ler, assinalando ou desmarcando as mesmas seis opções, e alterar quais as propriedades que abrange.

⚠️ Importante

A Amenitiz pede-lhe que confirme a palavra-passe da sua conta antes de mostrar ou substituir um segredo. O segredo dá acesso aos dados da sua propriedade, por isso confirmamos que é mesmo o utilizador.

📌 Nota

Retirar o acesso aplica-se de imediato e a ferramenta é desligada até se voltar a ligar. Adicionar acesso só chega à ferramenta na próxima vez que esta se ligar.

Manter as suas credenciais seguras

Trate o segredo como uma palavra-passe:

Nunca o partilhe publicamente nem o envie por e-mail ou chat sem segurança.
Dê-o apenas a ferramentas e pessoas em que confie.
Se achar que ficou exposto, substitua-o de imediato.

Para programadores

A documentação técnica completa está em developers.amenitiz.com.

A Amenitiz não presta apoio técnico para implementações da API. É uma integração avançada disponibilizada em regime de autosserviço.

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.

Um membro da equipa pode criar credenciais de API?

Não. Só o proprietário da conta pode criar uma credencial, mostrar ou substituir um segredo, ou revogar uma credencial.

Perdi o segredo. O que faço?

Abra a credencial e clique em Mostrar, depois confirme a palavra-passe da sua conta. Não perdeu nada: só precisa de substituir o segredo se achar que outra pessoa o viu.

Posso alterar o que uma credencial pode ler depois de a criar?

Sim. Abra a credencial e assinale ou desmarque as opções. Retirar o acesso aplica-se de imediato; adicionar acesso chega à ferramenta na próxima vez que esta se ligar.

Devo criar uma credencial por ferramenta?

Sim. Uma credencial separada para cada ferramenta permite-lhe substituir ou revogar uma sem cortar as outras, dar a cada ferramenta apenas o acesso de que precisa e ver de relance a que ferramenta pertence cada credencial.

Revoguei uma credencial por engano. Posso reativá-la?

Não. A revogação é permanente. Crie uma nova credencial e entregue o novo Client ID e o novo segredo à ferramenta ou ao programador.

Como criar e gerir as suas credenciais de API