| Parameter | Descrição |
|---|---|
| client_id | O identificador do aplicativo. Para saber como criar um Vantage API Client (client_id e client_secret), consulte o artigo Managing Tenant Vantage API Clients. |
| redirect_uri | A URL do seu aplicativo ou site usada para redirecionar o navegador após a concessão das permissões de acesso. |
| response_type=code | Especifica que o tipo de resposta será o código de autorização. |
| scope=openid permissions global.wildcard | Especifica o escopo de permissão. |
| state | Um valor string arbitrário que conterá o resultado da autorização na resposta. |
| code_challenge | Valor assinado digitalmente do código code_verifier (usando o método code_challenge_method). |
| code_challenge_method | O método de assinatura digital para o código code_verifier (S256). |
| productId=a8548c9b-cb90-4c66-8567-d7372bb9b963 | O identificador do Vantage. |
Os valores de response_type, scope e productId devem ser exatamente os especificados acima. Essas chaves, exceto response_type, estão sujeitas a alteração. Considere mantê-las em configuração.Exemplo de solicitação Um parâmetro chamado redirect_uri que contém o identificador do seu recurso é usado no OAuth 2.0 para permitir que o Vantage envie o código de autorização para o seu recurso e depois troque esse código pelo token de acesso, que é necessário para a autenticação em todas as chamadas subsequentes da API. Usar esse método de autenticação requer fornecer o valor do parâmetro redirect_uri ao suporte técnico da ABBYY para que ele seja incluído na lista de permissões pelos administradores. Depois que as permissões de acesso solicitadas usando o parâmetro scope forem verificadas e concedidas, o navegador será redirecionado para uma página da Web especial configurada pelo servidor do Vantage. Essa página da Web contém uma janela de diálogo usada para concluir a autorização com sua conta. Essa página deve ser aberta em um navegador que tenha uma barra de endereços visível, o que permitirá verificar a url da página e o estado do certificado SSL da conexão. Se seu endereço de e-mail estiver associado a várias contas em diferentes tenants, você será solicitado a selecionar um tenant e inserir sua senha depois de informar seu endereço de e-mail. Você também pode passar seu identificador de tenant (o parâmetro tokenId) diretamente usando um dos seguintes recursos: ou Será necessário inserir a senha da sua conta de tenant. Após inserir suas credenciais, a autorização é concluída no servidor, o aplicativo recebe acesso à Vantage API e você recebe o código de autorização na resposta à sua solicitação. Esteja ciente de que, se um site ou aplicativo usar esse tipo de autenticação, os usuários do Vantage concederão acesso à Vantage API, em seu nome, ao site ou app que você está adicionando à lista de URLs de redirecionamento permitidas. Para conceder acesso ao site ou app, será solicitado que os usuários se autentiquem no Vantage usando seu login e senha. Depois que um usuário for autenticado, o site ou app receberá as seguintes permissões:
- Gerenciar catálogos de dados no tenant do Vantage em nome do usuário,
- Acessar skills no tenant do Vantage em nome do usuário,
- Criar e acessar transações do Vantage em nome do usuário.
application/x-www-form-urlencoded.
Parâmetros do corpo da solicitação:
| Parameter | Descrição |
|---|---|
| code_verifier | O código que você gerou. Necessário para confirmar a iniciação da solicitação de autorização. |
| client_id | O identificador do aplicativo. |
| client_secret | Chave segura do aplicativo. |
| code | Seu código de autorização obtido do servidor. |
| redirect_uri | A URL de redirecionamento usada na etapa de autorização. |
| grant_type=authorization_code | Especifica que o tipo de concessão “authorization code” é usado. |
| scope=openid permissions global.wildcard offline_access | Especifica o escopo de permissões. Para obter um token de renovação, adicione offline_access ao escopo. |
token pelo valor que você recebeu:
Obtendo o refresh token
Allow issuing refresh tokens to refresh access tokens tiver sido habilitada ao configurar o cliente da Vantage API e a solicitação para obter o access token contiver o parâmetro scope=openid permissions global.wildcard offline_access, você também receberá um refresh token adicional na resposta. Depois de obter um refresh token, você poderá atualizar o access token usando uma solicitação POST para o endpoint de token com os seguintes parâmetros:
| Parameter | Description |
|---|---|
| client_id | O identificador do aplicativo. |
| client_secret | Uma chave de aplicativo segura. |
| refresh_token | Seu refresh token obtido do servidor. |
| grant_type=refresh_token | Especifica que está sendo usado o tipo de concessão de refresh token. |
Tempo de vida dos tokens
- Tempo de vida do token de acesso: Define o período durante o qual o token de acesso emitido permite que o usuário acesse o Vantage. O tempo de vida padrão de um token de acesso é de 24 horas.
- Tempo de vida do token de atualização: Define o período absoluto, a partir da emissão do primeiro token de acesso, durante o qual o token de atualização emitido pode ser usado para renovar o token de acesso. O tempo de vida padrão de um token de atualização é de 30 dias.