A versão francesa deste artigo foi atualizada desde a sua tradução. Ler a versão francesa
Ligue a sua ferramenta pela API
O seu software não está na lista? Gere um token de importação e faça com que a sua própria ferramenta envie os seus alojamentos, as suas reservas e os seus serviços, com a fonte personalizada.
O vídeo deste guia chega em breve.
A fonte personalizada (API) alimenta o The Big One a partir de qualquer ferramenta: o seu software próprio, uma folha de cálculo automatizada, uma ferramenta que não conhecemos. A sua ferramenta envia alojamentos, reservas, serviços e nomes de planeamento com um simples pedido. Este artigo mostra-lhe o que preparar e o que transmitir à pessoa que fará a ligação. Conte com 5 minutos do seu lado.
O seu software consta da página Integrações? É preferível associá-lo sem programação: Ligue o seu software de gestão.
O que a ligação sincroniza
| Dado | Sentido | Observação |
|---|---|---|
| Alojamentos | Da sua ferramenta para o The Big One | Um alojamento ausente de um envio nunca é eliminado |
| Reservas | Da sua ferramenta para o The Big One | Canceladas apenas se a sua ferramenta declarar um período completo |
| Serviços | Da sua ferramenta para o The Big One | Um serviço iniciado, terminado ou validado nunca é substituído |
| Nomes de planeamento | Da sua ferramenta para o The Big One | Associados às contas existentes; não é criada nenhuma conta |
Antes de começar
- É administrador: a página Integrações está reservada ao administrador.
- Uma pessoa sabe escrever um pequeno programa que envia dados: o seu programador, ou o fornecedor da sua ferramenta.
- Cada alojamento, reserva e serviço da sua ferramenta tem um identificador que não muda. Serve para não criar nenhum duplicado.
Gerar o token de importação
Passo a passo
- 1
Abra Definições › Fluxos e integrações › Integrações.
- 2
No topo da página, clique no filtro «Programadores». O cartão «Fonte personalizada (API)» encontra-se aí.
- 3
Clique em Gerar um token. Abre-se a janela «O seu token de importação».
- 4
Clique em Copiar o token. Aparece a mensagem «Token copiado.».
- 5
Guarde o token num local seguro e feche a janela. O cartão tem a menção «Token ativo».
Transmitir as informações ao seu programador
Passo a passo
- 1
No cartão, junto a «Endereço de envio:», clique em Copiar. Aparece a mensagem «Endereço copiado.».
- 2
Clique em Ver a documentação. A página descreve o endereço, os cabeçalhos, um exemplo completo, as regras de importação e os limites.
- 3
Envie ao seu programador o endereço de envio, a ligação da documentação e, por um canal seguro, o token.
As regras a conhecer antes de escrever o programa:
| Regra | O que significa |
|---|---|
| Um identificador por elemento | Cada elemento é reconhecido pelo seu identificador: enviar de novo o mesmo conteúdo não cria nenhum duplicado |
| Alojamento ausente de um envio | Nunca é eliminado: só conta o valor «ativo» enviado |
| Roupa do alojamento | Em cada envio, a parte da roupa da ficha é substituída por inteiro: o que foi escrito à mão é substituído |
| Serviço já iniciado | Nunca é substituído: apenas os seus campos vazios são preenchidos |
Verificar as importações
Passo a passo
- 1
No cartão «Fonte personalizada (API)», leia a linha «Última importação:». Dá a data do último envio recebido.
- 2
Expanda «Últimas 30 importações». Cada linha conta, por tipo de dado, os elementos criados, atualizados e mantidos.
- 3
Uma linha assinala erros? Expanda-a para ler o detalhe e transmita-o ao seu programador.
Revogar o token
Faz-se se o token tiver circulado, ou quando muda de ferramenta.
Passo a passo
- 1
No cartão, clique em Revogar. Abre-se a janela «Revogar o token?».
- 2
Clique em Revogar o token. Aparece a mensagem «Token revogado: as próximas chamadas serão recusadas.».
- 3
Para voltar a ligar a sua ferramenta, clique de novo em Gerar um token e dê o novo token ao seu programador.
Perguntas frequentes
É preciso um programador?
Sim. A fonte personalizada espera dados enviados por um programa. Sem programador, associe um software da página Integrações ou uma ligação iCal.
Um alojamento importado pela API pode ser ligado a um anúncio de outra integração?
Não. A sua ferramenta encontra-o pelo seu identificador em cada envio: não pode ser ligado a um anúncio de outra integração.
A minha ferramenta pode ser avisada quando um serviço termina?
Sim. No filtro «Programadores», o cartão «Acesso para programadores» permite adicionar um endereço a avisar quando um serviço é atribuído, iniciado, terminado ou validado.
O que acontece se eu gerar um novo token?
O anterior é revogado: os envios que o utilizam são recusados. Dê o novo token ao seu programador.
As contas dos profissionais de limpeza são criadas pela importação?
Não. Uma importação não cria nenhuma conta: os nomes sem correspondência são devolvidos à sua ferramenta para que convide a pessoa.