Chaves de API
Como criar e gerenciar chaves de API e tokens de acesso pessoal no Nobur.
O Nobur oferece chaves de API para integração com sistemas externos. As chaves permitem que aplicações de terceiros acessem os dados da plataforma de forma programática e segura.
Tipos de chaves
O Nobur possui dois tipos de chaves de autenticação:
Chaves de API (tenant/organização)
Chaves vinculadas ao tenant ou a uma organização específica. São utilizadas para integrações entre sistemas (machine-to-machine).
| Característica | Detalhe |
|---|---|
| Escopo | Tenant ou organização específica |
| Vinculação | Não vinculada a um usuário |
| Uso | Integrações automatizadas, webhooks, sistemas externos |
| Gerenciamento | Proprietários do tenant/organização |
Tokens de acesso pessoal (PAT)
Tokens vinculados a um usuário específico. As ações realizadas com o token são atribuídas ao usuário que o criou.
| Característica | Detalhe |
|---|---|
| Escopo | Mesmo acesso do usuário que criou |
| Vinculação | Vinculado ao usuário criador |
| Uso | Scripts pessoais, automações individuais |
| Gerenciamento | O próprio usuário |
Criando uma chave de API
Acesse a seção de chaves
No menu lateral, vá em Administração > Chaves de API.
Clique em Nova Chave
Selecione o tipo (chave de API ou token pessoal) e o escopo desejado.
Defina as permissões
Escolha quais recursos a chave poderá acessar (leitura, escrita, ou ambos) e para quais entidades (propostas, partes, imóveis, etc.).
Copie a chave gerada
A chave será exibida apenas uma vez. Copie e armazene em local seguro.
A chave é exibida apenas no momento da criação. Se você perder a chave, será necessário criar uma nova. O Nobur não armazena a chave em texto legível após a criação.
Permissões granulares
Cada chave pode ter permissões específicas, seguindo o princípio do menor privilégio:
- Leitura — consultar dados (listagem, detalhes, busca)
- Escrita — criar e editar registros
- Exclusão — remover registros
As permissões podem ser definidas por recurso:
- Propostas e contratos
- Partes (pessoas físicas e jurídicas)
- Imóveis
- Corretores
- Documentos
Segurança
Boas práticas para o uso de chaves de API:
- Nunca compartilhe chaves em canais inseguros (e-mail, mensagens de texto)
- Não inclua chaves no código-fonte — use variáveis de ambiente
- Revogue chaves não utilizadas — chaves antigas representam risco
- Use permissões mínimas — conceda apenas o acesso necessário para a integração
- Rotacione periodicamente — crie novas chaves e revogue as antigas regularmente
Revogando chaves
Para revogar uma chave que não será mais utilizada ou que foi comprometida:
- Acesse a lista de chaves em Administração > Chaves de API
- Localize a chave que deseja revogar
- Clique em Revogar e confirme
A revogação é imediata. Qualquer sistema que utilize a chave revogada perderá acesso instantaneamente.
Imagem ilustrativa será adicionada em breve.