Monitorando APIs baseadas em 2.0 da OAuth

O principal objetivo da primeira Tarefa Get Token é obter um token de acesso para o aplicativo acessar a API do serviço. Se for bem-sucedido, o token de acesso pode ser recuperado da resposta de API do serviço e usado nas solicitações subsequentes de API. Além disso, a tarefa verifica a troca de um código de autorização de aplicativo para o token de acesso. Em caso de erros, o alerta será gerado para o dispositivo.

Para criar um dispositivo, clique em Novo Dispositivo na página Gerenciador de dispositivos e selecione a tarefa HTTP/S.

URL

Para configurar a tarefa, precisamos gerar a solicitação de token de acesso ao Servidor de Autorização. No campo URL, especifique a URL do Servidor de Autorização de API no seguinte formato https://authorization-server.com/oauth/authorize. A URL exata depende do serviço ao qual você está se conectando.

Verificação de SSL/Certificado

Habilite verificações de certificados SSL.

Solicitar dados de tipo e postagem

Os parâmetros de autenticação do cliente(identidade do cliente e segredo do cliente), redirecionar URI e código de autorização devem ser fornecidos na solicitação ao Servidor de Autorização. Vamos usar o método POST (o campo Tipo de solicitação) para enviar detalhes e código do aplicativo.

No campo Post Data, precisamos especificar os seguintes atributos do corpo de solicitação:

• 
  client_id
  – seu identificador de aplicativo, emitido no primeiro registro do seu aplicativo no Servidor de Autorização.
• 
  client_secret
  – emitido no primeiro registro do seu aplicativo no Servidor de Autorização.
• 
  código
  – o código de autorização recebido do Servidor de Autorização.
• 
  grant_type
  – deve ser definido para “authorization_code“.
• 
  redirect_uri
  – a URL deve corresponder à URL de redirecionamento que você já registrou anteriormente no aplicativo.

Como resultado da execução da tarefa, receberemos uma resposta JSON com o token de acesso do Servidor de Autorização no órgão de resposta.

Validação de conteúdo

Para garantir que a resposta do servidor retorne o token de acesso e o token de atualização (seja usado se o token de acesso expirar), especifique as seguintes palavras-chave:

• access_token
• refresh_token

Para configurar outros campos de tarefas, se necessário, consulte Adicionar/Editar uma tarefa HTTP(S).

Uma vez concluída a configuração, clique em Criar dispositivo e proceda com o próximo passo para implementar uma chamada de API usando o token de acesso.

Quando a resposta da API com o token de acesso é recebida como resultado da execução da Tarefa Get Token, precisamos extrair o token para chamar a API do Serviço. Por exemplo, queremos recuperar a lista de usuários do serviço monitorado solicitando um ponto final /users.

Primeiro, crie um script para extrair o token do corpo de resposta Get Token Task a uma variável. Por exemplo, o script a seguir passa o token e o tipo de token da resposta de autorização básica para a variável TokenAuthorization:

string access_token;
string token_type;
string TokenAuthorization;

// get the authorization response from the first task
string json = (Tasks["Get Token"] as Http).body["//*"];

//convert response to the comma separated strings
string[] comas = json.Split(new Char[] { ',' });

// get the access token
int start1 = comas[0].IndexOf(":") + 2;
int length1 = comas[0].Length - start1 - 1;
access_token = comas[0].Substring(start1, length1); 

// get the token type
int start2 = comas[1].IndexOf(":") + 2;
int length2 = comas[1].Length - start2 - 1;
token_type = comas[1].Substring(start2, length2);

// set the TokenAuthorization variable to specify in the data request header 
TokenAuthorization = token_type + " " + access_token;

Para adicionar uma nova tarefa ao dispositivo de monitoramento de API configurado na primeira etapa:

1. Na página Gerenciador de dispositivos, clique no botão de ação na linha do dispositivo.
2. No menu de ação, selecione Adicionar tarefa.

URL

No campo URL, especifique solicitar URI do recurso de serviço do qual você precisa extrair dados.

Verificação de SSL/Certificado

Habilite verificações de certificado ssl.

Tipo de solicitação

Selecione o tipo de solicitação GET.

OAuth 2.0 requer que um token de acesso e o tipo de token sejam aprovados no cabeçalho de autorização da solicitação HTTP GET, mas você também pode fornecê-lo como uma sequência de consulta get ou parâmetro de corpo POST.

Cabeçalhos

Adicione o cabeçalho com o nome do cabeçalho Autorização

e o valor de Autorização de TokenAuthorization.

Para converter a variável
TokenAuthorization
em dinâmica, clique no ícone de engrenagem no campo de valor e na caixa de diálogo Editar valor, selecione Dinâmica.

O campo de valor dinâmico será marcado com os suportes.

Prepare Script

Adicione o script para passar no token de acesso.

Validação de conteúdo

Para verificar os dados devolvidos com a resposta do serviço, você também pode especificar palavras-chave correspondentes. Por exemplo, vários nomes de usuário que você espera recuperar do serviço.

Para configurar outros campos de tarefas, consulte Adicionar/Editar uma tarefa HTTP(S).