Chaves de API
O que é a funcionalidade de Chaves de API:
Uma funcionalidade desenvolvida pela Pier Cloud que permite criar chaves para integrar o ambiente do cliente com a API de serviços da Pier Cloud.
Como utilizar a funcionalidade Chaves de API:
Clicando no perfil do usuário, na opção “Configurações”, conforme ilustrado abaixo:
O sistema apresentará o menu lateral com algumas opções de configuração, onde deve ser selecionada a opção “Chaves de API”:
Na tela principal, o sistema permite visualizar a lista de Chaves de API cadastradas e adicionar novas Chaves clicando no botão "Adicionar":
Será apresentada a tela para cadastro de novas organizações, onde será necessário inserir as seguintes informações:
Nome: Fornecer o nome da organização ou aplicativo que deseja cadastrar
Descrição: Fornecer uma breve descrição da chave a ser criada:
Escopos: Inserir os escopos de role de permissão, que irá identificar as funcionalidades que o cliente terá acesso e o tipo de acesso.
Tempo de vida do token: Determinar a duração da chave de acesso do cliente, por padão será de uma hora, podendo ser utilizado a unidade de minutos também.
Unidade: Especificar a unidade de tempo que será utilizado no duração do token, podendo ser horas ou minutos.
Para horas, o sistema permite incluir um máximo de 24h
Para minutos, o sistema permite incluir um tempo máximo de 55min
Após inserir as informações necessárias, clicando no botão "Salvar", o sistema irá gerar um Client secret para que seja copiado e armazenado em um local seguro.
Obs.: Ao fechar a janela, a secret criada não será mais exibida, devendo ser armazenada em um local seguro antes de fechar a janela.
Ao clicar em Fechar, o sistema irá retornar para a tela principal de Chaves de API, onde será exibida e chave criada pelo tempo de vida especificado.
Filtros:
Na tela principal, o sistema permite aplicar alguns filtros de perquisa:
Chaves de API: É possível perquisar pelo nome da chave que deseja visualizar
Status: Além de pesquisar pelo status da chave, sendo eles: Todos, Ativas e Inativas.
Ações:
O sistema também permite realizar algumas ações para cada organização cadastrada:
Copiar para área de transferencia: Clicando no ícone "
", o sistema permite copiar a informação e colar em uma área de transferência.Ativar / Desativar: Clicando no ícone "
", é possível ativar ou desativar a chave criada.Deletar: Clicando no ícone da lixeira "
", o sistema apresentará uma mensagem de confirmação para que o usuário confirme exclusão da chave.
Editar: Clicando no ícone do lápis "
", o sistema abrirá a tela de edição, permitindo alterar informações como: Nome, Descrição, Escopos, Tempo de vida e Unidade de tempo. Não sendo permitido editar o Client ID.
Gerar novo client secret: O sistema permite gerar um novo client secret que irá substituir o client secret gerado anteriormente.
Clicando no botão "Gerar novo client secret", será apresentado uma janela com o novo secret gerado, para que o mesmo sejá copiado e armazenado em um local seguro:
Por fim, para acessar os endpoints a partir dessa chave criada, nós possuímos uma documentação complementar que pode ser acessar através desse link.
Last updated