Exercício – chamar uma API com uma chave de subscrição

  • 5 minutos

Uma chave de assinatura é uma maneira de restringir o acesso a uma API.

No exemplo da empresa de calçado, a NorthWind Shoes está a trabalhar com um fornecedor e pretende que o mesmo aceda diretamente à API Inventário. O acesso do parceiro deve ser restrito usando uma chave de assinatura para todas as chamadas para a API.

Aqui, você obtém uma chave de assinatura para sua API. Em seguida, você testa o acesso à API com e sem a chave de assinatura.

Obter a chave de subscrição

Os parceiros recebem as chaves como parte de um processo de inclusão. Neste exercício, você adiciona uma assinatura especificamente para a API NorthWindShoes. Depois de ter uma chave, você segue um processo padrão para usar a chave em chamadas de API.

  1. No menu do portal do Azure ou na página inicial, selecione Todos os recursos e, em seguida, selecione sua instância de Gerenciamento de API.

  2. No painel de menu esquerdo, em APIs, selecione Assinaturas.

  3. Selecione + Assinatura e insira os seguintes valores para cada configuração. Depois, selecione Criar.

    Definição Valor
    Nome NorthWind
    Display name NorthWind subscription
    Scope Selecione API e, em seguida, selecione Produtos NorthWindShoes na lista suspensa.

  4. Selecione o menu de contexto (...) para a assinatura Northwind e, em seguida, selecione Mostrar/ocultar chaves.

  5. Selecione o botão Clique para copiar para a CHAVE PRIMÁRIA.

  6. Guarde esta chave, por exemplo, no Bloco de Notas.

Utilizar a chave de subscrição na chamada à API

O próximo passo é utilizar a chave de subscrição para testar o acesso de programador à sua API publicada.

  1. Execute o seguinte comando no Cloud Shell para acessar a operação Produtos em sua API, substituindo <apim gateway> pelo nome do seu gateway.

    curl https://<apim gateway>.azure-api.net/api/Products

    Você recebe uma mensagem de chave de assinatura 401, Acesso negado devido à falta de mensagem de chave de assinatura.

  2. Agora repita o seu pedido de ondulação, desta vez incluindo a sua chave de subscrição.

  3. Execute o seguinte comando no Cloud Shell, substituindo pela chave que você salvou anteriormente e substituindo <primary key><apim gateway> pelo nome do seu gateway.

    curl --header "Ocp-Apim-Subscription-Key: <primary key>" https://<apim gateway>.azure-api.net/api/Products

    Agora, deverá conseguir aceder à API e ver uma lista de produtos devolvidos à consola.