/
Usuários de API

Usuários de API


Para acessar siga o caminho: Configurações > Preferencias > Segurança e Acessos > Usuários de API


O que é:

O usuário de API é criado para disponibilização das credenciais para utilização, assim, ela relaciona cada credencial com o usuário, disponibilizando assim um maior controle com a possibilidade de visibilidade dos logs de uso de cada usuário.

Você pode verificar a lista de Endpoints disponíveis para utilização em: Swagger UI


índice:


Adicionando novo usuário:

Ao clicar no botão “Adicionar” no canto superior direito será aberto uma tela onde será definido as seguintes informações do novo usuário:

  • Nome: Nome do usuário.

  • Email: Email para contato.

  • Telefone: Telefone para contato.

  • Situação: Situação atual do usuário.

    • Ativo: Usuário com liberação para utilização das credenciais.

    • Inativo: Usuário desativado que não possui mais acesso a utilização das credenciais.

  • Data de expiração: Data no qual o usuário irá expirar, sendo necessário a criação de um novo usuário.

O sistema irá enviar um e-mail de aviso quando o usuário estiver prestes a expirar

Após as inserir as informações será necessário utilizar o botão “salvar” para que sejam salvas e que sejam disponibilizada as Variáveis


Após o preenchimento dos campos você terá acesso as Variáveis abaixo:

  • Identificador do cliente

  • Segredo do cliente

  • Escopo

  • Segredo

  • Chave pública

  • Autorização

  • Autorização de token de curl

Estas variáveis são utilizadas para consumir a API de access_token, gerando uma chave de autorização que é utilizada na autenticação de outros endpoints.

para liberar os campos é necessário apertão o ícone de visualização no canto direito superior:

image-20240131-133851.png

Utilizando filtros:

Nos campos de filtro acima da lista de usuários de API já criados, haverá a possibilidade de filtrar pelas seguintes categorias:

  • Nome: Nome definido na criação do usuário de API.

  • Email: Email que está relacionado com o usuário.

  • Situação: Usuários Ativos ou Inativos.

  • Data de criação (inicio e fim): No primeiro campo define o começo da data de busca, e em seguida define a data final. O filtro irá demonstrar todos usuários criados entre as datas selecionadas.


Acessando logs:

De volta na lista de usuários de API já criados, acessando o botão de registros na coluna de logs será aberto a tela de logs do usuário.


Related content