Criar, configurar e excluir um cliente de API pública

1. No Vantage, clique em Configuration.
2. Na caixa de diálogo Tenant Adminstration, clique em Create API Client.

2. Para copiar cada valor, clique no ícone de cópia ao lado de cada um. Como alternativa, clique em Save to File para baixar um arquivo TXT contendo ambos os valores.

Importante! O valor do Client Secret é exibido apenas uma vez durante a criação do cliente, o que significa que ele precisa ser salvo imediatamente.

3. Clique em Close.
   A página Public API Client é exibida.

1. No Vantage, clique em Configuration.
2. Na caixa de diálogo Tenant Adminstration, clique em Public API Client.
3. Na página Public API Client, clique na lista suspensa New Client e clique em Add Client.

4. Para copiar cada valor, clique no ícone de cópia ao lado de cada um. Como alternativa, clique em Save to File para baixar um arquivo TXT contendo os dois valores.

Importante! O valor do segredo (Client Secret) é exibido apenas uma vez durante a criação do cliente, portanto precisa ser salvo imediatamente.

5. Clique em Close.
   A página Public API Client será exibida.

1. No campo Client Name, insira o nome do novo cliente de API pública.

2. Para criar um novo secret, clique em Add Secret. Por padrão, um secret é criado por um período de 6 meses. Você pode alterar o tempo de expiração e defini-lo em até 36 meses.
3. Para adicionar uma nova redirect URL, clique em Add Redirect URL.
4. Configure os fluxos de autenticação permitidos na seção OAuth 2.0 Flows Settings.
   Observação: Esse fluxo não funciona quando um External Identity Provider (provedor de identidade externo) está configurado.
   Você pode selecionar mais de um fluxo:
   • Allow Authorization Code Flow. Permite autenticação usando esse esquema de autenticação seguro, em que, em vez de direcionar a solicitação de autenticação para o usuário, o aplicativo a envia diretamente para o servidor de autorização do Vantage. O servidor de autorização então verifica as credenciais do usuário e fornece ao cliente um authorization code. Authorization Code Flow está habilitado para todos os Vantage API clients. Se necessário:
     • Selecione a opção Require PKCE for Authorization Code Flow. Essa opção reforça a segurança ao autorizar clientes públicos. Ela permite que o Vantage verifique se o aplicativo que está solicitando um access token é o mesmo que iniciou a autenticação.
   • Allow Resource Owner Password Credentials Flow. Permite que usuários se autentiquem usando seu nome de usuário e senha. Isso envolve o aplicativo ter acesso à senha do usuário e requer um alto nível de confiança entre o usuário e o aplicativo.
   • Selecione Allow issuing refresh tokens to refresh access tokens. Essa opção permite emitir refresh tokens para obter access tokens renovados. O aplicativo pode solicitar novos access tokens usando os refresh tokens sem interagir com o usuário. Os aplicativos devem armazenar os refresh tokens com segurança, pois eles permitem que o usuário permaneça autenticado.
5. Allow client credentials flow. Permite que aplicativos sejam autorizados usando o fluxo OAuth 2.0 Client Credentials, concedendo a eles acesso à Vantage API. As funções atribuídas aos aplicativos são determinadas pela configuração Manage Roles abaixo de Allow client credentials flow. Com as funções especificadas, o aplicativo fará login no Vantage.
6. Configure as Token Lifetime Settings:
   • Access Token. Define o período de tempo durante o qual o access token emitido permite o acesso do usuário ao Vantage. O tempo de vida padrão de um access token é de 24 horas.
   • Refresh Token. Define o período de tempo absoluto a partir da emissão do primeiro access token durante o qual o refresh token emitido pode ser usado para renovar o access token. O tempo de vida padrão de um refresh token é de 30 dias.