Tutorial: criar e publicar um produto

APLICA-SE A: Todas as camadas de gerenciamento de API

No Gerenciamento de API do Azure, um produto contém uma ou mais APIs, uma cota de uso e os termos de uso. Depois que um produto é publicado, os desenvolvedores podem assiná-lo e começar a usar as APIs do produto.

Neste tutorial, irá aprender a:

• Criar e publicar um produto
• Adicionar uma API ao produto
• Acessar APIs de produtos

Pré-requisitos

• Conhecer a terminologia da Gestão de API do Azure.
• Conclua o guia de início rápido seguinte: Criar uma instância da Gestão de API do Azure.
• Conclua também o tutorial seguinte: Importar e publicar a sua primeira API.

Criar e publicar um produto

Portal

1. Entre no portal do Azure e navegue até sua instância de Gerenciamento de API.

2. No painel de navegação esquerdo, selecione Produtos>+ Adicionar.

   

3. Na janela Adicionar produto, insira os valores descritos na tabela a seguir para criar seu produto.

   

   Nome	Descrição
   Display name	O nome como você deseja que ele seja mostrado no portal do desenvolvedor.
   Description	Forneça informações sobre o produto, como sua finalidade, as APIs às quais ele fornece acesso e outros detalhes.
   Estado	Selecione Publicado se quiser publicar o produto. Antes de as APIs num produto poderem ser chamadas, o produto tem de ser publicado. Por padrão, os novos produtos não são publicados e ficam visíveis apenas para o grupo Administradores .
   Exige subscrição	Selecione se um usuário precisa se inscrever para usar o produto (o produto está protegido) e uma chave de assinatura deve ser usada para acessar as APIs do produto. Se não for necessária uma subscrição (o produto está aberto), não é necessária uma chave de subscrição para aceder às APIs do produto. Consulte Acesso às APIs do produto mais adiante neste artigo.
   Requer aprovação	Selecione se pretende que um administrador reveja e aceite ou rejeite tentativas de subscrição deste produto. Se não for selecionada, as tentativas de assinatura serão aprovadas automaticamente.
   Limite da contagem de subscrições	Opcionalmente, limite a contagem de várias assinaturas simultâneas.
   Termos legais	Pode incluir os termos de utilização do produto, que os subscritores têm de aceitar para poderem utilizar o produto.
   APIs	Selecione uma ou mais APIs. Você também pode adicionar APIs depois de criar o produto. Para obter mais informações, consulte Adicionar APIs a um produto mais adiante neste artigo. Se o produto estiver aberto (não requer uma subscrição), só pode adicionar uma API que não esteja associada a outro produto aberto.

4. Selecione Criar para criar seu novo produto.

Atenção

Tenha cuidado ao configurar um produto que não requer uma assinatura. Essa configuração pode ser excessivamente permissiva e pode tornar as APIs do produto mais vulneráveis a determinadas ameaças à segurança da API.

CLI do Azure

Para começar a usar a CLI do Azure:

• Use o ambiente Bash no Azure Cloud Shell. Para obter mais informações, consulte Guia de início rápido para Bash no Azure Cloud Shell.

  

• Se preferir executar comandos de referência da CLI localmente, instale a CLI do Azure. Se estiver a utilizar o Windows ou macOS, considere executar a CLI do Azure num contentor Docker. Para obter mais informações, consulte Como executar a CLI do Azure em um contêiner do Docker.

  • Se estiver a utilizar uma instalação local, inicie sessão no CLI do Azure ao utilizar o comando az login. Para concluir o processo de autenticação, siga os passos apresentados no seu terminal. Para outras opções de entrada, consulte Entrar com a CLI do Azure.

  • Quando solicitado, instale a extensão da CLI do Azure na primeira utilização. Para obter mais informações sobre as extensões, veja Utilizar extensões com o CLI do Azure.

  • Execute o comando az version para localizar a versão e as bibliotecas dependentes instaladas. Para atualizar para a versão mais recente, execute o comando az upgrade.

Para criar um produto, execute o comando az apim product create :

az apim product create --resource-group apim-hello-word-resource-group \
    --product-name "Contoso product" --product-id contoso-product \
    --service-name apim-hello-world --subscription-required true \
    --state published --description "This is a test."

Você pode especificar vários valores para o seu produto:

Parâmetro	Description
--product-name	O nome como você deseja que ele seja mostrado no portal do desenvolvedor.
--description	Forneça informações sobre o produto, como sua finalidade, as APIs às quais ele fornece acesso e outros detalhes.
--state	Selecione publicado se quiser publicar o produto. Antes de as APIs num produto poderem ser chamadas, o produto tem de ser publicado. Por padrão, os novos produtos não são publicados e ficam visíveis apenas para o grupo Administradores .
--subscription-required	Selecione se um usuário precisa se inscrever para usar o produto (o produto está protegido) ou se uma assinatura não é necessária (o produto está aberto). Consulte Acesso às APIs do produto mais adiante neste artigo.
--approval-required	Selecione se pretende que um administrador reveja e aceite ou rejeite tentativas de subscrição deste produto. Se não for selecionada, as tentativas de assinatura serão aprovadas automaticamente.
--subscriptions-limit	Opcionalmente, limite a contagem de várias assinaturas simultâneas.
--legal-terms	Você pode incluir os termos de uso do produto, que os assinantes devem aceitar para usar o produto.

Atenção

Tenha cuidado ao configurar um produto que não requer uma assinatura. Essa configuração pode ser excessivamente permissiva e pode tornar as APIs do produto mais vulneráveis a determinadas ameaças à segurança da API.

Para ver seus produtos atuais, use o comando az apim product list :

az apim product list --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --output table

Você pode excluir um produto usando o comando az apim product delete :

az apim product delete --product-id contoso-product \
    --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --delete-subscriptions true

Adicionar mais configurações

Continue configurando o produto depois de salvá-lo. Na instância de Gerenciamento de API, selecione o produto na janela Produtos . Adicionar ou atualizar:

Item	Description
Definições	Metadados e estado do produto
APIs	APIs associadas ao produto
Políticas	Políticas aplicadas a APIs de produtos
Controlo de acesso	Visibilidade do produto para desenvolvedores ou convidados
Subscrições	Subscritores do produto

Adicionar APIs a um produto

Os produtos são associações de uma ou mais APIs. Pode incluir muitas APIs e oferecê-las aos programadores através do portal do programador. Durante a criação do produto, pode adicionar uma ou mais APIs existentes. Você também pode adicionar APIs ao produto mais tarde, na página Configurações de produtos ou durante a criação de uma API.

Adicionar uma API a um produto existente

Portal

1. Na navegação à esquerda da instância de Gerenciamento de API, selecione Produtos.
2. Selecione um produto e, em seguida, selecione APIs.
3. Selecione + Adicionar API.
4. Selecione uma ou mais APIs e, em seguida , Selecionar.

CLI do Azure

1. Para ver suas APIs gerenciadas, use o comando az apim api list:

   az apim api list --resource-group apim-hello-word-resource-group \
       --service-name apim-hello-world --output table
   

2. Para adicionar uma API ao seu produto, execute o comando az apim product api add :

   az apim product api add --resource-group apim-hello-word-resource-group \
       --api-id demo-conference-api --product-id contoso-product \
       --service-name apim-hello-world
   

3. Verifique a adição usando o comando az apim product api list:

   az apim product api list --resource-group apim-hello-word-resource-group \
       --product-id contoso-product --service-name apim-hello-world --output table
   

Você pode remover uma API de um produto usando o comando az apim product api delete :

az apim product api delete --resource-group apim-hello-word-resource-group \
    --api-id demo-conference-api --product-id contoso-product \
    --service-name apim-hello-world

Acesso às APIs do produto

Depois de publicar um produto, os desenvolvedores podem acessar as APIs. Dependendo de como o produto está configurado, eles podem precisar assinar o produto para acesso.

• Produto protegido - Os programadores têm primeiro de subscrever um produto protegido para terem acesso às APIs do produto. Quando se inscrevem, recebem uma chave de subscrição que pode aceder a qualquer API desse produto. Se você criou a instância de Gerenciamento de API, já é um administrador, portanto, está inscrito em todos os produtos por padrão. Para obter mais informações, consulte Assinaturas no Gerenciamento de API do Azure.

  Quando um cliente faz uma solicitação de API com uma chave de assinatura de produto válida, o Gerenciamento de API processa a solicitação e permite o acesso no contexto do produto. Políticas e regras de controle de acesso configuradas para o produto podem ser aplicadas.

  Gorjeta

  Você pode criar ou atualizar a assinatura de um usuário para um produto com chaves de assinatura personalizadas por meio de uma API REST ou comando do PowerShell.

• Produto aberto - Os desenvolvedores podem acessar as APIs de um produto aberto sem uma chave de assinatura. No entanto, você pode configurar outros mecanismos para proteger o acesso do cliente às APIs, incluindo OAuth 2.0, certificados de cliente e restrição de endereços IP do chamador.

  Nota

  Os produtos abertos não estão listados no portal do desenvolvedor para que os desenvolvedores conheçam ou se inscrevam. Eles são visíveis apenas para o grupo Administradores . Você precisará usar outro mecanismo para informar os desenvolvedores sobre APIs que podem ser acessadas sem uma chave de assinatura.

  Quando um cliente faz uma solicitação de API sem uma chave de assinatura:

  • O Gerenciamento de API verifica se a API está associada a um produto aberto. Uma API pode ser associada, no máximo, a um produto aberto.

  • Se o produto aberto existir, ele processa a solicitação no contexto desse produto aberto. Políticas e regras de controle de acesso configuradas para o produto aberto podem ser aplicadas.

Para obter mais informações, consulte Como o gerenciamento de API lida com solicitações com ou sem chaves de assinatura.

Próximos passos

Neste tutorial, ficou a saber como:

• Criar e publicar um produto
• Adicionar uma API ao produto
• Acessar APIs de produtos

Avance para o tutorial seguinte:

Criar API em branco e simular respostas da API