Gerenciamento de Clients de API
Todas as APIs transacionais do Authfy MFAO (Duplo fator de autenticação e Análise de Risco) 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_config_clients
Obtem a lista dos Clients de API
No Menu lateral do Console WEB selecione API Clients e então selecione List
Criando um Novo Client de API
URL de documentação da API:
/apidocs/#/Authentication_Providers/post_config_providers_auth
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:
No menu lateral selecione a opção API Clients então selecione Register.
No formulário preencha o campo Name com um nome para o Client de API e clique em Submit
Será apresentado um modal com o access-key do Client, guarda em local seguro
Observação: Caso você perca este access-key o mesmo pode ser resetado posteriormente.
Guarde as Informações necessárias para o consumo das APIs em local seguro:
- access-key: Obtida no passo 3 acima.
- client-id: Clique em Copy Client ID
Resetando o Access Key
URL de documentação da API:
/apidocs/#/Clients/put_config_clients__id_
Observação: É a mesma API de atualização do Client, porém deve ser utilizado o parâmetro reset com o valor true.
Resetar a Access Key de um Client de API
Para realizar a configuração através do Console Web, siga as seguintes instruções:
No menu lateral selecione a opção API Clients então selecione List.
Selecione na lista o Client desejado e clique em Reset Access Key
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_config_clients__id_
Atualizar um Client de API
Para realizar a configuração através do Console Web, siga as seguintes instruções:
No menu lateral selecione a opção API Clients então selecione List.
Selecione na lista o Client desejado e clique em Edit
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_config_clients__id_
Para realizar a configuração através do Console Web, siga as seguintes instruções:
No menu lateral selecione a opção API Clients então selecione List.
Selecione na lista o Client desejado e clique em Delete
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]'