Pular para o conteúdo principal
Você pode criar e configurar clientes da Vantage API na guia Configuration no painel esquerdo. Para criar um cliente de API, siga estas etapas:
  1. Clique em Create API Client.
Create API Client
  1. Na caixa de diálogo que será aberta, serão exibidos o Client ID e o Client Secret do cliente criado. Você pode salvar os valores clicando no ícone ao lado de cada um. Como alternativa, clique no botão Save to File e especifique um local onde será salvo um arquivo TXT contendo os valores de Client ID e Client Secret.
Importante! O valor do segredo é mostrado apenas uma vez durante a criação do cliente, portanto, ele precisa ser salvo imediatamente. Client ID and Secret Dialog
  1. Clique em Close.
Após as etapas acima, você será direcionado automaticamente para a página de edição do cliente criado. Nela, você poderá:
  • Alterar o nome do cliente no campo Client Name.
  • Criar um novo segredo clicando em Add Secret. Por padrão, um segredo é criado com validade de 6 meses.
  • Adicionar uma nova URL de redirecionamento clicando em Add Redirect URL.
  • Configurar os fluxos de autenticação permitidos na seção OAuth 2.0 Flows Settings. Você pode selecionar mais de um fluxo:
    • Allow Authorization Code Flow. Permite a autenticação usando este esquema seguro em que, em vez de encaminhar a solicitação de autenticação ao usuário, o aplicativo a envia diretamente ao servidor de autorização do Vantage. O servidor de autorização então verifica as credenciais do usuário e fornece ao cliente um código de autorização. O Authorization Code Flow é habilitado para todos os clientes da Vantage API. 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 solicita um token de acesso é o mesmo que iniciou a autenticação.
      • Selecione Allow issuing refresh tokens to refresh access tokens. Essa opção permite emitir tokens de atualização para obter novos tokens de acesso. O aplicativo pode solicitar novos tokens de acesso usando os tokens de atualização sem interagir com o usuário. Os aplicativos devem armazenar tokens de atualização com segurança, pois eles permitem que o usuário permaneça autenticado.
    • Allow Resource Owner Password Credentials Flow. Permite que os usuários se autentiquem usando 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.
Observação: Esse fluxo não funciona quando um Provedor de Identidade Externo está configurado.
  • Allow client credentials flow. Permite que aplicativos sejam autorizados usando o fluxo OAuth 2.0 Client Credentials, concedendo-lhes 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.
Para obter mais informações sobre fluxos de autenticação, consulte Authentication. OAuth 2.0 Configuration Se você quiser criar um novo cliente, selecione Add Client na lista suspensa New Client. Essa lista também exibirá todos os clientes existentes; clicar em qualquer um deles abrirá a página de edição do cliente selecionado. Além disso, se necessário, você pode pesquisar pelo nome do cliente e pelas funções. New Client Dropdown Para excluir um cliente, clique no ícone e depois em Delete Client. Delete Client