Controlar o acesso às suas APIs através do registo de apps

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Esta secção descreve como registar apps e gerir chaves da API.

Vista geral

A principal forma de controlar quem pode aceder às suas APIs é através do registo de aplicações.

Enquanto fornecedor de APIs, cria um ou mais produtos de API que agrupam as suas APIs em níveis de serviço. Os produtos de API permitem-lhe limitar o tráfego e os níveis de acesso a níveis muito detalhados. Quando cria um produto de API, pode definir o nível de acesso como Público, Privado ou apenas Interno. Para mais informações, consulte o artigo Nível de acesso.

Quando regista uma app, o programador da app seleciona os produtos de API a usar e o Apigee fornece uma única chave da API que o programador usa para aceder a esses produtos de API. O programador da app transmite a chave da API em cada chamada aos proxies de API contidos nos produtos de API. Em qualquer altura, pode revogar a chave da API de uma app, impedindo que um programador de apps aceda a todos ou a um subconjunto de produtos da API referenciados por essa app.

Normalmente, os programadores de apps registam-se para usar os seus produtos de API através do seu portal do programador. Os passos para criar o seu portal e publicar os seus produtos de API são descritos no artigo Crie o seu portal.

Em alternativa, pode ter mais controlo sobre o processo de registo de apps registando as suas apps através da IU do Apigee ou da API Apigee. Por exemplo, pode querer registar apps para as suas equipas de desenvolvimento internas ou para um programador que não consiga aceder ao seu portal.

Tem de ser um administrador da organização ou ter uma função com as autorizações adequadas para registar apps e gerir chaves de API.

As secções seguintes descrevem como registar apps e gerir chaves de API através da IU e da API.

Explorar a página Apps

Para ver e registar apps, e gerir chaves da API na IU do Apigee, use a vista Apps.

Aceda à página Distribuição > Apps na consola do Apigee in Cloud:

Aceda a Apps

A vista Apps permite-lhe fazer o seguinte:

• Registe uma app
• Veja e edite uma app
• Faça a gestão das credenciais
• Aprove ou revogue uma app
• Elimine uma app
• Pesquise a lista de apps por nome, programador, ID da app, chave da API de consumidor ou todo o conteúdo

Nota: à medida que o número geral de apps aumenta, as latências do tempo de carregamento na vista Apps aumentam. Use filtros para refinar a lista de apps e melhorar os tempos de carregamento.

Registar uma app

Aviso: certifique-se sempre de que a sua app inclui, pelo menos, um produto API no qual é especificado, pelo menos, um proxy de API e/ou um caminho de recurso. Se o produto de API não incluir um proxy de API e/ou um caminho de recurso, a chave da app pode ser usada para chamar qualquer proxy de API na sua organização do Apigee. Na maioria das situações, não quer criar uma chamada chave mestra, uma chave que pode abrir qualquer porta da sua casa!

Uma app pode ser registada das seguintes formas:

• Por um programador de apps: um programador de apps pode registar a app através do seu portal, conforme descrito em Como os programadores de apps interagem com o seu portal.
• Por um administrador: pode registar uma app no Apigee, conforme descrito abaixo. Cabe-lhe a si determinar como fornecer a chave ao programador da app.

As apps registadas são adicionadas ao seguinte:

• Lista de apps registadas no Apigee. Consulte o artigo Ver e editar detalhes do programador.
• Página Apps no portal do programador.

Para registar uma app no Apigee:

1. Aceda à página Distribuição > Apps:

   Aceda a Apps

2. Clique em Criar.
3. Especifique os detalhes da app, conforme descrito na tabela seguinte:

   Campo	Descrição	Obrigatório?
   Nome	Nome da app. Não pode alterar o nome depois de criar a app. Este nome é usado em chamadas da API Apigee.	Obrigatória
   Nome a apresentar	Nome a apresentar da app que aparece na IU do Apigee e no portal do programador.	Opcional
   Programador	Selecione um nome de programador no menu pendente. Nota: por motivos de desempenho, nem todos os programadores são apresentados no menu pendente. Comece a escrever o nome ou o email do programador na caixa de pesquisa. Os valores do menu pendente são automaticamente refinados para corresponderem ao texto que está a escrever. Consulte também o artigo Registe programadores de apps.	Obrigatória
   URL de retorno	Normalmente, especifica o URL de uma app designada para receber um código de autorização em nome da app cliente. Este valor não é obrigatório para todos os produtos API.	Opcional
   Notas	Notas descritivas para a app.	Opcional

   Nota: os detalhes da app também incluem um ID da app que só é visível e editável a partir da API e não da IU. Consulte o recurso REST: organizations.developers.apps.
4. Especifique as credenciais, incluindo a data de validade e o estado da chave da API, bem como os produtos da API associados. Na secção Credenciais, clique em Adicionar credencial e introduza as seguintes informações:

   Campo	Descrição
   Expira	Selecione uma duração ou uma data de validade, ou defina a chave da API para que nunca expire.
   Produtos	Associe um ou mais produtos API à chave da API: Clique em Adicionar produtos. Selecione um ou mais produtos de API na lista. Nota: tem de selecionar, pelo menos, um produto de API. Clique em OK. Clique em Adicionar.

5. Defina o Estado como Aprovado ou Revogado para cada produto API. Se adicionou um produto API à credencial que requer aprovação manual, é apresentado Pending approval status. Caso contrário, é apresentado Approved. Neste passo, pode alterar o estado de aprovação.
   1. Na lista de Produtos na secção Credenciais, selecione um ou mais produtos da lista.
   2. Clique em Aprovar ou Revogar.
6. Especifique os atributos personalizados:
   1. Na secção Atributos personalizados, clique em Adicionar atributo.
   2. Introduza o nome e o valor.
   3. Clique em Adicionar atributo. para adicionar mais atributos. O número máximo de atributos personalizados que pode adicionar é 18.
7. Clique em Criar.

Se os produtos de API que associou à app exigirem aprovação manual para as respetivas chaves de API, aprove-os, conforme descrito no artigo Aprovar ou revogar chaves de API.

Visualizar apps registadas para um programador

Para ver as apps registadas para um programador específico, use um dos seguintes métodos:

• Ver todas as apps registadas, clique em Filtrar, clique em Proprietário da app e introduza o nome do programador no campo de pesquisa.
• Veja todos os programadores de apps registados e clique na linha associada ao programador.

Visualizar e editar uma app

Nota: antes de editar atributos personalizados, certifique-se de que não existem dependências do sistema nas definições de atributos existentes.

O Apigee mantém as seguintes entidades na cache durante um mínimo de 180 segundos após o acesso às entidades.

• Tokens de acesso OAuth. Isto significa que o elemento ExpiresIn na política OAuth v2 não vai poder fazer expirar uma chave de acesso em menos de 180 segundos.
• Entidades do Key Management Service (KMS) (Apps, Developers e API Products).
• Atributos personalizados em tokens OAuth e entidades KMS.

Para ver e editar uma app:

1. Aceda à página Distribuição > Apps:

   Aceda a Apps

2. Clique em qualquer parte da linha da app que quer ver e editar. O Apigee apresenta os detalhes da app.
   Nota: as apps que fazem parte de AppGroups também são apresentadas na lista de resultados. Pode ver os detalhes das apps e eliminar apps de AppGroups, mas não pode criá-las nem editá-las nesta vista. Para obter instruções sobre como gerir apps e grupos de apps, consulte o artigo Usar grupos de apps para organizar a propriedade das apps.
3. Para editar uma app, clique em Editar.
4. Realize uma ou mais das seguintes tarefas:
   • Modifique os detalhes da app, incluindo o nome, o URL de retorno de chamada ou as notas.
   • Faça a gestão das credenciais e dos produtos associados.
   • Adicione ou elimine atributos personalizados. O número máximo de atributos personalizados que pode adicionar é 18.
   • Aprovar ou revogar a app.
5. Clique em Guardar.

Gerir credenciais

Quando edita uma app, pode gerir as respetivas credenciais na secção Credenciais, onde pode realizar as seguintes tarefas através da IU:

• Veja uma chave da API e um segredo
• Aprove ou revogue uma chave da API para todos os produtos de API associados ou para um único produto de API.
• Faça a gestão de produtos de API numa app
• Gere novas credenciais

Para usar a API para gerir credenciais, consulte o artigo Importar chaves e segredos de consumidor existentes.

Nota: quando cria um produto API, também pode definir o respetivo nível de acesso como Apenas interno ou Privado. Os produtos de API marcados como Apenas interno ou Privado não são apresentados aos programadores no portal do programador. Para aceder a estes produtos, adicione-os manualmente à app de um programador a partir da API Apigee.

Ver uma chave da API e um segredo

Para ver uma chave da API e um segredo:

1. Aceda à página Distribuição > Apps:

   Aceda a Apps

2. Clique na linha da app para a qual quer ver a chave da API e o segredo.
3. Na secção Credenciais, clique no ícone associado à chave da API ou ao segredo que quer ver.

Aprovar ou revogar uma chave da API

As chamadas da API para proxies de API requerem normalmente uma chave da API. O Apigee só permite as chamadas se a chave da API for aprovada, válida e cumprir as condições definidas pelo produto da API que contém a API.

Pode configurar um produto de API para aprovação automática de chaves de API, conforme descrito no artigo Gerir produtos de API. No entanto, se o produto API exigir a aprovação manual das chaves da API, tem de aprovar manualmente a chave.

Pode revogar uma chave da API para todos ou um único produto da API. Neste caso, a chave da API e o segredo são inválidos e não podem ser usados para aceder às APIs nos produtos de API associados. Pode voltar a aprovar uma chave de API em qualquer altura.

Para aprovar ou revogar uma chave da API:

1. Aceda à página Distribuição > Apps:

   Aceda a Apps

2. Clique na linha da app que quer ver e editar.
3. Clique em Editar.
4. Para aprovar ou revogar uma chave de API, selecione Aprovado ou Revogado na secção Estado para a credencial.
5. Clique em Guardar.

Gerir produtos de API numa app

Faça a gestão dos produtos de API na sua app através da realização das seguintes tarefas:

• Adicione um produto API a uma app
• Remova um produto API de uma app

Adicionar um produto API a uma app

Para adicionar um produto API a uma app:

1. Aceda à página Distribuição > Apps:

   Aceda a Apps

2. Clique na linha da app que quer ver e editar.
3. Clique em Editar.
4. Realize uma das seguintes tarefas:
   • Para adicionar um produto de API a uma nova chave da API, clique em Adicionar credencial para gerar uma nova credencial, selecione uma data de validade e adicione o produto de API à chave da API.
   • Para adicionar um ou mais produtos de API a uma chave de API existente, na secção Credenciais, clique em Adicionar produtos e selecione um ou mais produtos de API na lista pendente.
5. Clique em Guardar.

Revogar ou remover um produto API de uma credencial de app

Se quiser manter uma chave de API ativa, mas não permitir que seja usada por um produto de API, pode revogá-la ou removê-la da credencial associada.

1. Aceda à página Distribuição > Apps:

   Aceda a Apps

2. Clique na linha da app que quer ver e editar.
3. Clique em Editar.
4. Selecione o produto (ou produtos) da API a revogar ou remover da credencial.
5. Clique em Revogar ou Remover.
6. Clique em Guardar.

Pode voltar a aprovar um produto de API revogado ou voltar a adicionar um produto de API que foi removido.

A gerar novas credenciais

Pode gerar novas credenciais para uma app. Por exemplo, se estiver a usar a rotação de chaves da API, pode gerar novas chaves cuja expiração se sobreponha às chaves que vão ficar fora de rotação quando expirarem. Também pode gerar uma nova chave/segredo se a segurança da chave/segredo original for comprometida. Se gerar uma nova chave, todas as chaves de API existentes continuam a funcionar até expirarem ou as revogar explicitamente.

Para gerar uma nova chave da API:

1. Aceda à página Distribuição > Apps:

   Aceda a Apps

2. Clique na linha da app que quer ver e editar.
3. Clique em Edit.
4. Na secção Credenciais, clique em Adicionar credencial.
5. Especifique a validade, adicione os produtos da API e defina o respetivo estado.
6. Opcionalmente, revogue qualquer uma das outras chaves da API, conforme necessário.
7. Clique em Guardar.

Aprovar ou revogar uma app

Nota: pode aprovar ou revogar apps associadas a um utilizador específico, conforme descrito em Gerir utilizadores do portal

Aprovar ou revogar uma app, conforme descrito abaixo. Quando revoga uma app, as chaves de API aprovadas deixam de poder ser usadas em chamadas de API para o Apigee. Quando volta a aprovar uma app, todas as chaves da API aprovadas e válidas podem ser usadas para fazer chamadas da API.

Se a app estiver registada noutras organizações, tem de a revogar em cada uma dessas organizações. As alterações podem demorar alguns minutos a serem reconhecidas por todos os processadores de mensagens.

Para aprovar ou revogar uma app:

1. Aceda à página Distribuição > Apps:

   Aceda a Apps

2. Clique na linha da app que quer ver e editar.
3. Clique em Edit.
4. Selecione Aprovar ou Revogar no campo Estado da app para aprovar ou revogar a app, respetivamente.
5. Clique em Guardar.

Eliminar uma app

Quando elimina uma app, todas as chaves de cliente associadas às apps tornam-se inválidas. A utilização de uma chave inválida num pedido faz com que o pedido falhe.

Se considerar que pode querer repor uma app de programador no futuro, uma alternativa à eliminação é revogar uma app.

Para eliminar uma app:

1. Aceda à página Distribuição > Apps:

   Aceda a Apps

2. Posicione o cursor na linha da app a eliminar.
3. Clique em Mais Eliminar na coluna Ações.

Nota: com o Apigee, a eliminação da app de programador e dos artefactos associados ocorre de forma assíncrona. A app do programador é eliminada imediatamente, mas os recursos associados a essa app do programador, como chaves de apps ou tokens de acesso, podem demorar alguns segundos a alguns minutos a serem eliminados.

Registar apps e gerir chaves da API através da API

Para registar e gerir apps através da API Apigee, use as seguintes APIs:

• API Apps
• API de apps para programadores
• API Developer app keys

Consulte também Importe chaves e segredos de consumidor existentes.