Chaves de API e a API
Permita que outro sistema leia e escreva seus dados do IDup sob uma chave que você pode renovar ou excluir, e encontre o guia da API.
Uma chave de API é uma senha que pertence a um programa em vez de uma pessoa. Trate-a da mesma forma: emita uma por sistema e substitua-a quando esse sistema mudar.
Criar uma chave
- Abrir API → Gestão de API e pressione Nova chave.
- Dê um nome que indique qual sistema o utiliza.
- Escolha seu Permissões: Acesso total, ou apenas as áreas que o sistema precisa. A maioria das áreas distingue leitura, criação e alteração.
- Escolha uma data de validade, ou nenhuma.
- Usar Mostrar e Copiar no cartão-chave para entregar a chave ao sistema chamador. O sistema a envia no authtoken cabeçalho.
Cada cartão-chave mostra as permissões, a data de criação, Último uso e um selo como “ativo” ou “expira em 5 dias”.
Renovar uma chave antes que expire
Quatorze dias antes de uma chave expirar, você recebe uma notificação no sino. Pressione Renovar no cartão-chave e escolha a nova data de validade. O IDup cria uma nova chave com as mesmas permissões. Copie-a imediatamente, pois esta exibição aparece apenas uma vez. A chave antiga permanece válida até sua própria expiração, para que você possa mudar o sistema sem interrupção.
As áreas que você pode alcançar
A API cobre seus dados de clientes e, dependendo do seu plano, propriedades e aluguéis, perfis de busca, 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 suas próprias áreas. O guia da API lista apenas as áreas incluídas no seu plano.
O guia da API
Abrir o Documentação aba na página de gerenciamento de API, ou API → Guia da API. Cada área mostra seus campos, exemplos de solicitações que você pode copiar, respostas de exemplo e códigos de erro.
Webhooks e outras interfaces
- O Webhooks aba envia eventos para o seu sistema à medida que acontecem — 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 aba abre suas configurações, por exemplo, se os clientes podem se registrar através da API.
- Automação / fluxos de trabalho → Interface técnica emite um token para a interface GraphQL.
- AI Studio → Chaves de API Pessoais é um conjunto separado de chaves.
Mantendo em segurança
- Uma chave por sistema, nunca uma compartilhada.
- Dê a uma chave apenas as permissões que o sistema precisa.
- Defina uma data de validade e renove em um cronograma.
- Exclua uma chave assim que alguém que a conhecia sair, ou o sistema for desligado.
Nada é rastreado — os botões apenas abrem uma mensagem para que você possa nos dizer o que estava faltando.
