Como controlar o acesso às APIs registrando aplicativos

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Esta seção descreve como registrar aplicativos e gerenciar chaves de API.

Visão geral

A principal forma de controlar quem pode acessar suas APIs é por meio do registro do aplicativo.

Como provedor de API, você cria um ou mais produtos de API que agrupam suas APIs em camadas de serviço. Com os produtos de API, é possível limitar os níveis de tráfego e acesso em níveis muito granulares. Ao criar um produto de API, você pode definir o nível de acesso como público, privado ou interno. Para mais informações, consulte Nível de acesso.

Ao registrar um aplicativo, o desenvolvedor do aplicativo seleciona quais produtos de API usar e o Apigee fornece uma única chave de API que o desenvolvedor usa para acessar os produtos da API. O desenvolvedor do app transmite a chave de API em cada chamada para os proxies de API contidos nos produtos da API. A qualquer momento, é possível revogar a chave de API de um app, impedindo que um desenvolvedor de apps acesse todos ou um subconjunto de produtos de API referenciados pelo app.

Normalmente, os desenvolvedores de apps usam o portal do desenvolvedor para se registrar para usar os produtos de API. As etapas para criar o portal e publicar produtos de API são descritas em Criar seu portal.

Para ter mais controle sobre o processo de registro, registre seus aplicativos usando a Apigee no console do Cloud ou a API Apigee. Por exemplo, você pode registrar apps para suas equipes de desenvolvimento interno ou para um desenvolvedor que não consegue acessar seu portal.

Você precisa ser um administrador da organização ou receber um papel com as permissões apropriadas para registrar aplicativos e gerenciar chaves de API.

As seções a seguir descrevem como registrar aplicativos e gerenciar chaves de API usando a IU e a API.

Como explorar a página "Aplicativos"

Para registrar apps e gerenciar chaves de API na IU da Apigee, use a visualização Apps.

Acesse a página Apps no console do Apigee no Cloud:

Acessar "Apps".

A visualização Apps permite que você faça o seguinte:

• Registrar um aplicativo
• Ver e editar um aplicativo
• Gerenciar credenciais
• Aprovar ou revogar um aplicativo
• Excluir um app
• Pesquisar a lista de aplicativos por nome, desenvolvedor, ID, chave da API do consumidor ou todo o conteúdo.

Como registrar um aplicativo

Alerta: sempre verifique se o app inclui pelo menos um produto de API em que pelo menos um proxy de API e/ou caminho de recurso estejam especificados. Se o produto de API não incluir um proxy de API e/ou caminho de recurso, a chave do app poderá ser usada para chamar qualquer proxy de API na organização do Apigee. Na maioria das situações, não é recomendado criar uma chave esqueleto, uma chave que pode abrir qualquer porta da casa.

Um aplicativo pode ser registrado das seguintes maneiras:

• Por um desenvolvedor de apps: um desenvolvedor de apps pode registrar o app no seu portal, conforme descrito em Como os desenvolvedores de apps interagem com seu portal.
• Por um administrador: é possível registrar um app na Apigee, conforme descrito abaixo. Você determina como fornecer a chave ao desenvolvedor do app.

Os aplicativos registrados são adicionados ao seguinte:

• Lista de aplicativos registrados no Apigee. Consulte Como visualizar e editar detalhes do desenvolvedor.
• Página "Aplicativos" no portal do desenvolvedor.

Para registrar um aplicativo no Apigee:

1. Acesse a página Apps:

   Acessar "Apps".

2. Clique em Criar.
3. Especifique os Detalhes do app, conforme descrito na tabela a seguir:

   Campo	Descrição	Obrigatório?
   Nome	Nome do app. Não é possível mudar o nome após a criação do app. Esse nome é usado nas chamadas para a API Apigee.	Obrigatório
   Nome de exibição	Nome de exibição do app que aparece na IU do Apigee e no portal do desenvolvedor.	Opcional
   Desenvolvedor	Selecione um nome de desenvolvedor na lista suspensa. Observação: por motivos de desempenho, nem todos os desenvolvedores são exibidos na lista suspensa. Comece a digitar o nome ou o e-mail do desenvolvedor na caixa de pesquisa, e os valores da lista suspensa serão automaticamente refinados para corresponder ao texto que você está digitando. Consulte também Registrar desenvolvedores de apps.	Obrigatório
   URL de callback	Normalmente especifica o URL de um aplicativo designado para receber um código de autorização em nome do aplicativo cliente. Esse valor não é obrigatório para todos os produtos de API.	Opcional
   Observações	Notas descritivas do aplicativo.	Opcional

4. Especifique as Credenciais, incluindo a expiração e o status da chave da API e os produtos da API associados. Na seção Credenciais, clique em Adicionar credencial e digite as seguintes informações:

   Campo	Descrição
   Término	Configure uma duração ou data de validade ou defina a chave de API para nunca expirar e clique em OK.
   Produtos	Associe um ou mais produtos da API à chave de API: Clique em Adicionar produtos. Selecione um ou mais produtos da API na lista. Observação:pelo menos um produto de API precisa ser selecionado. Clique em OK. Clique em Adicionar.

5. Defina o Status como "Aprovado" ou "Revogado" para cada produto da API. Se você adicionou um produto de API à credencial que exige aprovação manual, o Pending approval status será mostrado. Caso contrário, ele mostrará Approved. Nesta etapa, você pode mudar o status de aprovação.
   1. Na lista de produtos na seção Credenciais, selecione um ou mais produtos da lista.
   2. Clique em Aprovar ou Revogar.
6. Especifique os Atributos personalizados:
   1. Na seção "Atributos personalizados", clique em Adicionar atributo.
   2. Digite o nome e o valor.
   3. Clique em Adicionar ou Adicionar e iniciar outro. O número máximo de atributos personalizados que podem ser adicionados é 18.
7. Clique em Criar.

Se os produtos de API associados ao aplicativo precisarem de aprovação manual para as chaves de API, aprove-os conforme descrito em Aprovar ou revogar chaves de API.

Como visualizar aplicativos registrados para um desenvolvedor

Para visualizar os aplicativos registrados para um desenvolvedor específico, use um dos seguintes métodos:

• Veja todos os aplicativos registrados, selecione Desenvolvedor na lista suspensa "Pesquisar" e insira o nome do desenvolvedor no campo de pesquisa.
• Veja todos os desenvolvedores registrados e clique na linha associada ao desenvolvedor.

Como visualizar e editar um aplicativo

Observação: antes de editar os atributos personalizados, verifique se não há dependências do sistema nas configurações de atributos atuais.

A Apigee mantém as seguintes entidades em cache por pelo menos 180 segundos após serem acessadas.

• Tokens de acesso do OAuth Isso significa que o elemento ExpiresIn na política do OAuth v2 não poderá expirar um token de acesso em menos de 180 segundos.
• Entidades de serviço de gerenciamento de chaves (KMS) (apps, desenvolvedores, produtos de API).
• Atributos personalizados em tokens OAuth e entidades KMS.

Para visualizar e editar um aplicativo:

1. Acesse a página Apps:

   Acessar "Apps".

2. Clique em qualquer lugar na linha do app que você quer visualizar e editar. O Apigee exibe os detalhes do aplicativo.
   Observação: os apps que fazem parte de AppGroups também aparecem na lista de resultados. Você pode conferir detalhes e excluir apps do AppGroup, mas não criar nem editar nessa visualização. Para instruções sobre como gerenciar o AppGroups e apps do AppGroups, consulte Como usar o AppGroups para organizar a propriedade de apps.
3. Para editar um app, clique em Editar.
4. Execute uma ou mais das seguintes tarefas:
   • Modifique os detalhes do app, incluindo nome, URL de callback ou observações.
   • Gerencie as credenciais e os produtos associados.
   • Adicione ou exclua atributos personalizados.O número máximo de atributos personalizados é 18.
   • Aprove ou revogue o app.
5. Clique em Salvar.

Como gerenciar credenciais

Ao editar um app, é possível gerenciar as credenciais dele na seção Credenciais, onde é possível realizar as seguintes tarefas usando a UI:

• Visualizar um secret e uma chave de API
• Aprovar ou revogar uma chave de API para todos os produtos de API associados ou para um único produto de API.
• Gerenciar produtos de API em um app
• Gerar novas credenciais

Para usar a API para gerenciar credenciais, consulte Importar as chaves e os secrets do cliente.

Observação: ao criar um produto de API, também é possível definir o nível de acesso como Apenas interno ou Particular. Os produtos de API marcados como Apenas interno ou Particular não aparecem para desenvolvedores no portal do desenvolvedor. Para ter acesso a esses produtos, adicione-os manualmente ao app de um desenvolvedor com a API Apigee.

Como ver uma chave de API e um secret

Para ver uma chave de API e um secret:

1. Acesse a página Apps:

   Acessar "Apps".

2. Clique na linha do aplicativo para que você quer ver a chave e o secret da API.
3. Na seção "Credenciais", clique no associado à chave ou ao secret da API que você quer visualizar.

Como aprovar ou revogar uma chave de API

As chamadas de API para proxies de API geralmente exigem uma chave de API. O Apigee permite as chamadas somente se a chave de API for aprovada, válida e atender às condições definidas pelo produto de API que contém a API.

É possível configurar um produto de API para aprovação automática de chaves de API, conforme descrito em Gerenciar produtos de API. No entanto, se o produto de API exigir a aprovação manual das chaves de API, você precisará aprovar a chave manualmente.

É possível revogar uma chave de API para um único produto de API ou para todos. Nesse caso, o secret e a chave de API são inválidos e não podem ser usados para acessar as APIs nos produtos de API associados. Chaves de API podem ser aprovadas novamente a qualquer momento.

Para aprovar ou revogar uma chave de API, faça o seguinte:

1. Acesse a página Apps:

   Acessar "Apps".

2. Clique na linha do aplicativo que você quer visualizar e editar.
3. Clique em Editar.
4. Para aprovar ou revogar uma chave de API, selecione Aprovado ou Revogado na seção Status da credencial.
5. Clique em Salvar.

Como gerenciar produtos de API em um aplicativo

Realize as tarefas a seguir para gerenciar os produtos de API no aplicativo:

• Adicionar um produto de API a um app
• Remover um produto de API de um app

Como adicionar um produto de API a um aplicativo

Para adicionar um produto de API a um app:

1. Acesse a página Apps:

   Acessar "Apps".

2. Clique na linha do aplicativo que você quer visualizar e editar.
3. Clique em Editar.
4. Execute uma das seguintes tarefas:
   • Para adicionar um produto de API a uma nova chave de API, clique em Adicionar credencial para gerar uma nova credencial, selecione uma operação e adicione o produto à chave de API.
   • Para adicionar um ou mais produtos de API a uma chave de API, clique em Adicionar produtos na seção "Credenciais" e selecione um ou mais produtos de API na lista suspensa.
5. Clique em Salvar.

Como revogar ou remover um produto de API de uma credencial do app

Se você quiser manter uma chave de API ativa sem permitir que ela seja usada por um produto de API, revogue-a ou remova-a da credencial associada.

1. Acesse a página Apps:

   Acessar "Apps".

2. Clique na linha do aplicativo que você quer visualizar e editar.
3. Clique em Editar.
4. Selecione os produtos de API que você quer revogar ou remover da credencial.
5. Clique em Revogar ou Remover.
6. Clique em Salvar.

É possível aprovar novamente um produto de API revogado ou adicionar novamente um produto de API removido.

Como gerar novas credenciais

É possível gerar novas credenciais para um aplicativo. Por exemplo, se você estiver usando a rotação de chaves de API, poderá gerar novas chaves com expiração simultânea à das chaves que estarão fora da rotação quando expirarem. Também é possível gerar uma nova chave/secret caso a segurança da original seja comprometida. Se você gerar uma nova chave, todas as chaves de API atuais continuarão funcionando até que expirem ou que sejam revogadas explicitamente.

Para gerar uma nova chave de API:

1. Acesse a página Apps:

   Acessar "Apps".

2. Clique na linha do aplicativo que você quer visualizar e editar.
3. Clique em Editar.
4. Na seção "Credenciais", clique em Adicionar credencial.
5. Especifique a validade, adicione os produtos da API e defina o status deles.
6. Se quiser, revogue qualquer uma das outras chaves de API, conforme necessário.
7. Clique em Salvar.

Como aprovar ou revogar um aplicativo

Observação: é possível aprovar ou revogar aplicativos associados a um usuário específico, conforme descrito em Gerenciar usuários do portal

Para aprovar ou revogar um aplicativo, siga as instruções abaixo. Quando você revoga um app, as chaves de API aprovadas não podem mais ser usadas em chamadas de API para o Apigee. Quando você aprova novamente um aplicativo, todas as chaves de API aprovadas e válidas podem ser usadas para fazer chamadas de API.

Se o aplicativo estiver registrado em outras organizações, você precisará revogá-lo em cada uma delas. Pode levar alguns minutos para que as alterações sejam reconhecidas por todos os processadores de mensagens.

Para aprovar ou revogar um aplicativo:

1. Acesse a página Apps:

   Acessar "Apps".

2. Clique na linha do aplicativo que você quer visualizar e editar.
3. Clique em Editar.
4. Selecione Aprovar ou Revogar no campo Status do app para aprovar ou revogar o app, respectivamente.
5. Clique em Salvar.

Como excluir um aplicativo

Quando você exclui um app, todas as chaves do cliente associadas a ele se tornam inválidas. Usar uma chave inválida em uma solicitação faz com que ela falhe.

Se você acredita que pode querer restaurar um app do desenvolvedor no futuro, uma alternativa é revogar o app.

Para excluir um app:

1. Acesse a página Apps:

   Acessar "Apps".

2. Posicione o cursor na linha do app que você quer excluir.
3. Clique em na coluna de ações.

Observação:: com a Apigee, o app do desenvolvedor e os artefatos associados são excluídos de maneira assíncrona. O app do desenvolvedor é excluído imediatamente, mas os recursos associados a ele, como chaves de app ou tokens de acesso, podem levar de alguns segundos a alguns minutos para serem excluídos.

Como registrar aplicativos e gerenciar chaves de API usando a API

Para registrar e gerenciar aplicativos usando a API Apigee, use as seguintes APIs:

• API Apps
• API Apps para desenvolvedores
• API de chaves do app do desenvolvedor

Consulte também Importar secrets e chaves do cliente.