Como gerar um token de acesso à API do OZmap
A API do OZmap permite que outros sistemas se conectem ao OZmap sem usar usuário e senha. Para isso, cada usuário de API tem um clientId e um clientSecret, e a integração usa esse par para pedir um token de acesso.
Antes de começar
O usuário precisa ter o módulo API marcado. Sem ele, a API não libera o acesso e o sistema exibe a mensagem "O usuário não tem acesso à API".
Passo a passo
No menu lateral esquerdo, clique em Usuários.
Abra o usuário de API. Se ainda não existir, crie um novo com o botão Novo usuário.
Em Módulos, marque API. Se o usuário também precisar acessar o OZmap, mantenha OZmap marcado.
Salve o usuário.
Role até a seção Configuração API e clique em Gerar um token.
Um aviso informa que usuários com chave de API têm acesso ao sistema limitado ao uso da API. Confirme com OK.
Em seguida, aparecem o clientId e o clientSecret do usuário.
Campos Usuário e Módulos, com o módulo API marcado.
Seção Configuração API, com clientId e clientSecret.
Sobre o clientId e o clientSecret
O clientId é um código gerado pelo sistema. Ele não é mais o nome do usuário.
O clientSecret é exibido apenas uma vez. Copie-o e guarde em local seguro, pois não será possível visualizá-lo novamente.
Se o clientSecret for perdido, use o botão de regenerar para criar um novo. O anterior deixa de funcionar.
O botão de copiar ao lado do clientSecret copia o valor para a área de transferência.
Como a integração usa o par
A integração envia o clientId e o clientSecret para obter um token de acesso e, a partir daí, usa a API com esse token. Cada usuário de API tem seu próprio par.
Boas práticas
Use um usuário dedicado para cada integração, com acesso apenas aos projetos necessários.
Não compartilhe o clientSecret em e-mails, chats ou documentos. Se ele vazar, regenere o clientSecret imediatamente.
Se um usuário de API não for mais usado, remova o acesso ao módulo API.