Gerenciamento de Clients de API

Todas as APIs transacionais do Authfy Risk utilizam 2 headers como autenticação, o client-id e access-key, eles podem ser genrenciados pelo usuários administrador ou por qualquer usuário com perfil administrativo, a seguir será demonstrado como realizar as configurações e gerenciamento destes clients de API.

Listando Clients de API

• URL de documentação da API: /apidocs/#/clients/get_clients

• Obtem a lista dos Clients de API

• No Menu lateral do Console WEB selecione Clients

  

Criando um Novo Client de API

• URL de documentação da API: /apidocs/#/clients/post_clients

• Registra um novo Client de API para acesso as APIs transacionais

• Para realizar a configuração através do Console Web, siga as seguintes instruções:

  1. No menu lateral selecione a opção Clients então selecione New.

  2. No formulário preencha os seguintes campos:

     • Name: Nome para o Client de API.
     • Lockdown Count: Selecione uma contagem de lockdown dos usuários, número de vezes que o usuário pode chamar a API dentro dos segundos definidos no Lockdown Range.
     • Lockdown Range: Número de segundos que o usuário pode chamar a API dentro do número de chamadas definido em Lockdown Count.
     • Lockdown Time: Número de segundos em que o usuário ficará impossibilitado de chamar a API após atingir o Lockdown Count dentro do Lockdown Range.

  3. Na listagem irá aparecer o novo client, as credenciais de acesso a API podem ser obitidas do seguinte modo:

     • Access-key clicando no seguinte ícone, estará disponível no Ctrl+V após clicar:
     • Client-id clicando no seguinte ícone, estará disponível no Ctrl+V após clicar:

  4. Guarde as Informações necessárias para o consumo das APIs em local seguro:

     • access-key: Obtida no passo 3 acima.
     • client-id: Obtida no passo 3 acima.

  

Resetando o Access Key

• URL de documentação da API: /apidocs/#/clients/put_clients__id__reset

• Resetar a Access Key de um Client de API

• Para realizar a configuração através do Console Web, siga as seguintes instruções:

  1. No menu lateral selecione a opção Clients.

  2. Selecione na lista o Client desejado e clique no ícone de reset de access key.

  3. Uma nova Access Key estara disponível no clipboard (CTRL+V)

     

Atualizando um Client de API

• URL de documentação da API: /apidocs/#/clients/put_clients__id_

• Atualizar um Client de API

• Para realizar a configuração através do Console Web, siga as seguintes instruções:

  1. No menu lateral selecione a opção API Clients.

  2. Selecione na lista o Client desejado e clique no ícone de editar.

  3. Estara disponível as informações do Client em um formulário, após alterar, clique em Submit

     

Deletando um Client de API

• URL de documentação da API: /apidocs/#/clients/delete_clients__id_

• Para realizar a configuração através do Console Web, siga as seguintes instruções:

  1. No menu lateral selecione a opção Clients.

  2. Selecione na lista o Client desejado e clique no ícone de excluir.

  3. Após isso aparecerá uma tela de confirmação, clique em Confirm

     

Utilizando um Client de API

• Para utilizar o Client de API utilize o seguinte comando curl como exemplo:

curl -H 'client-id:[Client-ID]' -H 'access-key:[Access Key]'