Chaves de API e a API

Uma chave API é uma senha que pertence a um programa em vez de a uma pessoa. Trate-a da mesma forma: emita uma por sistema e substitua-a quando esse sistema mudar.

Criar uma chave

1. Abrir API → Gestão de API e pressione Nova chave.
2. Dê-lhe um nome que indique qual o sistema que o utiliza.
3. Escolha o seu Permissões: Acesso total, ou apenas as áreas que o sistema necessita. A maioria das áreas distingue leitura, criação e alteração.
4. Escolher uma data de validade, ou nenhuma.
5. Utilizar Mostrar e Copiar no cartão de chave para entregar a chave ao sistema de chamada. O sistema envia-a no authtoken cabeçalho.

Cada cartão-chave mostra as permissões, a data de criação, Última utilização e um distintivo como “ativo” ou “expira em 5 dias”.

Renovar uma chave antes de expirar

Catorze dias antes de uma chave expirar, recebe uma notificação no sino. Pressione Renovar no cartão de chave e escolha a nova data de validade. O IDup cria uma nova chave com as mesmas permissões. Copie-a de imediato, pois esta exibição aparece apenas uma vez. A chave antiga permanece válida até à sua própria expiração, para que possa mudar o sistema sem interrupções.

As áreas que pode alcançar

A API abrange os dados dos seus clientes e, dependendo do seu plano, propriedades e alugueres, perfis de pesquisa, arquivos fiscais, arquivos de fiduciários, contabilidade, execuções de folha de pagamento e digitalização de recibos. O AI Studio e a caixa de entrada têm as suas próprias áreas. O guia da API lista apenas as áreas que o seu plano inclui.

O guia da API

Abrir o Documentação separador na página de gestão de API, ou API → Guia da API. Cada área mostra os seus campos, exemplos de pedidos que pode copiar, exemplos de respostas e códigos de erro.

Webhooks e outras interfaces

• O Webhooks separador envia eventos para o seu sistema à medida que ocorrem — veja Enviar eventos para o seu próprio sistema com webhooks.
• Se a API do Cliente estiver ativada, um Configurações da API de Clientes separador abre as suas definições, por exemplo, se os clientes podem registar-se através da API.
• Automação / Fluxos de trabalho → Interface técnica emite um token para a interface GraphQL.
• AI Studio → Chaves API pessoais é um conjunto separado de chaves.

Manter em segurança

1. Uma chave por sistema, nunca uma partilhada.
2. Dê a uma chave apenas as permissões que o sistema necessita.
3. Defina uma data de validade e renove conforme um cronograma.
4. Eliminar uma chave assim que alguém que a conhecia sair, ou o sistema for desligado.