Esta página aplica-se ao Apigee e ao Apigee Hybrid.
Veja a documentação do
Apigee Edge.
Os produtos de API agrupam as suas APIs e disponibilizam-nas aos programadores de apps para consumo. Para uma vista geral dos produtos de API, consulte o artigo O que é um produto de API?
Explorar a página de vista geral dos produtos de API
A página de vista geral Produtos apresenta todos os seus produtos de API e alguns detalhes sobre cada um deles. Nesta página, pode criar um novo produto API, eliminar um produto ou selecionar um para ver ou editar.
Para aceder à página de vista geral Produtos na consola do Google Cloud:
A IU de produtos permite-lhe realizar as seguintes tarefas comuns:
- Adicione um produto API
- Edite um produto da API
- Pesquise a lista de produtos de API
- Elimine um produto da API
Estas tarefas estão descritas nas secções seguintes.
Crie um produto de API
Esta secção descreve como criar um produto API através das IUs do Apigee.
Para criar um produto de API através da IU do Apigee:
Aceda à página de vista geral Produtos:
- Clique em + Criar. É apresentada a página de configuração do produto.
- Configure o produto API. As partes da página de configuração do produto incluem o seguinte:
- Detalhes do produto: informações básicas sobre o produto da API, como o nome, o nível de acesso (privado, público ou interno) e os âmbitos de OAuth.
- Operações: grupos de proxies de API, caminhos de recursos e métodos HTTP suportados por este produto de API. Também pode definir limites de quotas para cada operação.
- Operações GraphQL: grupos de proxies de API, caminhos de recursos e tipos de operações GraphQL suportados por este produto de API. Os tipos de operações GraphQL suportados incluem consultas e mutações. Pode especificar um tipo ou o outro, ou ambos. Tal como nos proxies de API baseados em REST, pode definir limites de quota em cada operação.
- Operações gRPC: especifique proxies da API gRPC e métodos gRPC suportados por este produto de API. Tal como para os proxies de API baseados em REST, pode definir limites de quota nas operações.
- Atributos personalizados: pares de chave/valor que ajudam a controlar a execução do proxy API.
Cada uma destas partes principais é descrita nas secções abaixo.
- Quando terminar, clique em Guardar. O Apigee cria o novo produto de API. Agora, pode anexar o produto a uma app de programador. Consulte o artigo Controlar o acesso às suas APIs registando apps. Para ver exemplos adicionais, consulte os artigos Proteja uma API exigindo chaves da API e Proteja uma API com OAuth.
Detalhes do produto
Na secção Detalhes do produto, introduza informações básicas sobre o seu novo produto de API. A tabela seguinte descreve os campos nesta secção:
| Campo | Obrigatório? | Descrição |
|---|---|---|
Name |
Obrigatória |
Define o nome interno do produto API. Usa este valor em chamadas para a API Apigee que fazem referência ao produto API. O valor do campo Por exemplo, |
Display name |
Obrigatória |
Define o nome usado na IU do Apigee para o produto API. Pode editar o nome a apresentar do produto API em qualquer altura. O Por exemplo, |
Description |
Opcional |
Uma string que pode ajudar a lembrar-se da finalidade ou da função do produto API. A descrição pode incluir carateres especiais. Por exemplo, |
Space |
Opcional |
Se a sua organização tiver o Apigee Spaces ativado, pode associar o produto de API a um espaço selecionado na lista de opções disponíveis. Para mais informações, consulte o artigo Vista geral do Apigee Spaces. |
Environment |
Opcional |
Identifica os ambientes aos quais o produto API permite o acesso. Se não forem especificados ambientes, o produto API permite todos os ambientes. Os ambientes que selecionar neste campo restringem o acesso aos proxies de API com base na respetiva implementação. Por exemplo, se o proxy de API A for implementado nos ambientes |
Access |
Obrigatória | O nível de acesso concedido aos utilizadores deste produto de API. Para ver detalhes, consulte os níveis de acesso. |
Automatically approve access requests |
Opcional (predefinição: selecionado) |
Ativa a aprovação automática de pedidos de chaves recebidos para este produto de API de qualquer app. Para exigir a aprovação manual de chaves, desative esta opção. A opção predefinida está selecionada, o que significa que este produto API aprova automaticamente os pedidos de chaves. Se selecionar a aprovação manual de chaves, tem de aprovar os pedidos de chaves recebidos de qualquer app que use este produto de API. Para aprovar chaves manualmente:
Para mais informações, consulte o artigo Registar apps e gerir chaves da API. |
Quota |
Opcional |
Define limites no número de pedidos permitidos para este produto API. Este valor aplica-se à soma dos pedidos de todas as operações para este produto de API. Este valor é substituído por limites de quota mais específicos definidos nas operações que define no produto da API. A introdução de um valor de quota não aplica automaticamente restrições ao número de chamadas que podem ser feitas através do produto API. Também tem de adicionar a Política de Quotas aos proxies de API referenciados pelo produto de API. Para mais informações, consulte a secção Quotas. |
Allowed OAuth scope |
Opcional | Se estiver a usar o OAuth com o produto API, introduza uma lista separada por vírgulas dos âmbitos de OAuth que quer que o produto API permita (como Read ou outros âmbitos que as apps enviam com as respetivas chamadas da API). Para mais informações, consulte Âmbitos do OAuth. |
Operações
Especificar as operações permitidas num proxy de API baseado em HTTP, incluindo caminhos de recursos, métodos HTTP e quotas. As operações permitem-lhe controlar que métodos REST e que caminhos de recursos num produto de API, e quantas dessas chamadas podem ser feitas (com a quota).
Para configurar os detalhes da operação, clique em + ADICIONAR UMA OPERAÇÃO na secção Operações. É apresentada a vista Operação.
| Campo | Obrigatório? | Descrição |
|---|---|---|
API proxy |
Obrigatória |
Selecione o proxy de API a associar a esta operação. |
Path |
Obrigatória |
Introduza o caminho do recurso para a operação. Pode usar o caminho da operação para permitir ou não permitir pedidos a URIs específicos. Por
exemplo, se definir a origem da operação para o proxy da API Neste caso, as chamadas para Tenha em atenção que existem regras especiais para carateres universais em caminhos de recursos, conforme descrito no artigo Configurar caminhos de recursos. |
Methods |
Opcional |
Selecione um ou mais métodos de pedido HTTP na lista pendente. (Estes métodos são por vezes conhecidos como verbos HTTP.) O Apigee permite pedidos ao proxy de API que só correspondem aos métodos que selecionar. A predefinição é nenhuma seleção, o que permite pedidos com quaisquer métodos HTTP. Se não selecionar, pelo menos, um método, o Apigee insere Para ver informações sobre a funcionalidade dos métodos de pedidos HTTP, consulte o artigo Métodos de pedidos HTTP. |
Quota |
Opcional | Especifique limites de quota para esta operação. Para ver detalhes sobre como as quotas são contabilizadas, consulte o artigo Compreender os contadores de quotas. |
Custom attributes |
Opcional | Consulte Atributos personalizados. |
Operações GraphQL
Para configurar os detalhes da operação GraphQL, clique em + ADICIONAR UMA OPERAÇÃO na secção Operações GraphQL. É apresentada a vista Operação. Consulte também o artigo Usar o GraphQL.
| Campo | Obrigatório? | Descrição |
|---|---|---|
API proxy |
Obrigatória |
Selecione o proxy de API a associar a esta operação. |
Operation name |
Obrigatória |
Especifique um nome para a operação |
Operation type |
Opcional |
Selecione um ou mais tipos de operações GraphQL na lista pendente. O Apigee permite pedidos ao proxy de API que só correspondem aos tipos de operações que selecionar. A predefinição é nenhuma seleção, o que permite pedidos com qualquer tipo de operação. Se não selecionar, pelo menos, um tipo, o Apigee insere Para ver informações sobre a funcionalidade dos tipos de operações GraphQL, consulte o artigo Consultas e mutações. |
Quota |
Opcional | Especifique limites de quota para esta operação. Esta quota substitui a quota definida no produto da API. Consulte Quota. |
Custom attributes |
Opcional | Consulte Atributos personalizados. |
Operações gRPC
Para configurar os detalhes da operação gRPC, clique em + ADICIONAR UMA OPERAÇÃO na secção Operações gRPC. É apresentada a vista Operação. Consulte também Criar proxies de API gRPC.
| Campo | Obrigatório? | Descrição |
|---|---|---|
API proxy |
Obrigatória |
Selecione o proxy de API a associar a esta operação. |
Service name |
Obrigatória |
Especifique um nome para a operação. Para a versão atual, não existe a opção de indicar o nome do servidor de destino. (O nome do serviço e o servidor de destino são os mesmos.) |
gRPC methods in service |
Opcional |
Introduza os métodos gRPC disponíveis, usando uma lista separada por vírgulas para vários métodos. |
Quota |
Opcional | Especifique limites de quota para estas operações. Esta quota substitui a quota definida no produto da API. Consulte Quota. |
Custom attributes |
Opcional | Consulte Atributos personalizados. |
Atributos personalizados
Os atributos personalizados são pares de chave/valor que podem ser usados de várias formas, incluindo ajudar a controlar a execução do proxy da API.
No total, um produto de API pode ter até 18 atributos personalizados, incluindo os definidos em operações.
Por exemplo, pode criar um atributo personalizado denominado deprecated com um valor de true ou false. No fluxo do proxy da API, pode verificar o valor do atributo deprecated do produto da API. Se o valor for true, pode gerar um erro com a política RaiseFault porque quer que essa operação se comporte como se estivesse descontinuada e já não fosse suportada.
Quota
Pode definir as definições de quota para o produto API ou por âmbito de operação. Existem três campos que tem de especificar quando define uma quota:
- O número máximo de pedidos a permitir de uma app de programador para o período especificado. Este campo corresponde ao elemento
<Allow>numa política de quota. - O intervalo de tempo de reposição da quota. Este campo corresponde ao elemento
<Interval>numa política de quotas. - A unidade do período de reposição (ou unidade de tempo), como dia, semana ou mês. Este campo
corresponde ao elemento
<TimeUnit>numa política de quotas.
Este exemplo define um limite de 1000 pedidos ao produto API por dia, adicionando:
- 1000 para o número máximo de pedidos.
- 1 para o intervalo de tempo de reposição.
- dia para a unidade do período de reposição.
Quando define uma quota para uma operação, tem de introduzir valores para todos os três campos na secção Quota.
Pode definir uma quota distinta para cada operação. Se uma operação especificar vários métodos HTTP, a quota aplica-se a todos os métodos nessa operação. Para permitir quotas distintas para cada método, defina várias operações com um único método em cada operação.
Se definir estes valores na Política de quotas e no produto de API (na IU, conforme descrito aqui ou com a API Products API), as definições da IU/API do produto de API têm precedência.
Configurar caminhos de recursos
Tenha em atenção as seguintes regras para caminhos de recursos:
/: indica que o caminho base e todos os subcaminhos do caminho base são suportados./**: indica que todos os subcaminhos do caminho base são suportados (mas não o caminho base)./*: indica que apenas são suportados URIs um nível abaixo do caminho base.- Os caminhos dos recursos especificados no produto API ou nas respetivas operações aplicam-se a todos os proxies de API adicionados ao produto API.
- Os caminhos de recursos mais inclusivos e menos específicos têm precedência sobre os que são
mais específicos. Por exemplo, se adicionar
/e/**, o caminho do recurso/tem precedência e o caminho do recurso/**é ignorado.
Usar carateres universais em caminhos de recursos
É importante ter em atenção que, nas definições do caminho do recurso do Apigee, não é permitido um asterisco único (*) nem um asterisco duplo (**) como parte do nome de um segmento do caminho (por exemplo, /abc*/a), mas é permitido quando usado como um segmento do caminho completo para representar um caráter universal (por exemplo, /*/a) ou uma correspondência de caminho gananciosa (por exemplo, /abc/**).
Por exemplo:
- Válido:
/*/aou/abc/**. O caráter universal é o seu próprio subcaminho. - Inválido:
/abc/*aou/abc*/a. O caráter universal é combinado com outros carateres no subcaminho.
Esta regra garante que o caráter universal é interpretado como um marcador de posição claro e explícito para um segmento de caminho completo, em vez de um padrão a ser correspondido no nome de um único segmento de caminho.
Comportamento predefinido dos caminhos dos recursos
A tabela seguinte mostra o comportamento predefinido de um produto API para diferentes caminhos de recursos. Neste exemplo, o proxy de API tem um caminho base de
/v1/weatherapikey. O caminho do recurso do produto API aplica-se ao sufixo do caminho após o caminho base.
| URI do pedido | Permitido para / |
Permitido para /* |
Permitido para /** |
Permitido para /*/2/** |
Permitido para /*/2/* |
|---|---|---|---|---|---|
/v1/weatherapikey |
|||||
/v1/weatherapikey/ |
|||||
/v1/weatherapikey/1 |
|||||
/v1/weatherapikey/1/ |
|||||
/v1/weatherapikey/1/2 |
|||||
/v1/weatherapikey/1/2/ |
|||||
/v1/weatherapikey/1/2/3/ |
|||||
/v1/weatherapikey/1/a/2/3/ |
Um caminho de recurso de / num produto de API
suporta o caminho base e todos os subcaminhos. Por exemplo, se o caminho base do proxy de API for /v1/weatherapikey, o produto de API suporta pedidos para /v1/weatherapikey e para quaisquer subcaminhos, como /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA e assim sucessivamente.
Para mais informações, consulte o artigo Compreender a configuração do produto API.
Editar um produto de API
Para editar um produto de API:
Aceda à página de vista geral Produtos:
- Clique na linha do produto de API que quer editar. O Apigee apresenta os detalhes do produto da API.
- Clique em EDITAR.
-
Edite as definições do produto API, conforme necessário.
Não pode editar um recurso de API existente. Em alternativa, tem de eliminar o recurso da API e adicionar uma nova versão com os valores corrigidos se quiser alterá-lo.
Pode eliminar um recurso se estiver a funcionar incorretamente ou exigir mais desenvolvimento. Quando é eliminado, esse recurso deixa de fazer parte do produto API atual. Qualquer app que use o produto API já não pode aceder ao recurso eliminado. Os recursos eliminados são removidos de um produto de API, mas não são eliminados do sistema, pelo que podem continuar a ser usados por outros produtos de API.
- (Opcional) Se a rentabilização do Apigee estiver ativada, crie um plano tarifário para o produto da API clicando em Adicionar plano tarifário ou
(interface do utilizador clássica). -
Clique em Guardar.
As alterações entram em vigor num curto período de tempo (aproximadamente cinco minutos).
Eliminar um produto API
Antes de poder eliminar um produto de API, tem de anular o registo/desassociar todas as apps de programador associadas ao produto. Pode fazê-lo eliminando as apps ou revogando as chaves da API das apps.
Para eliminar um produto de API:
Aceda à página de vista geral Produtos:
- Abra o menu Ações na linha do produto da API que quer eliminar e selecione Eliminar.
- Depois de confirmar a operação de eliminação, a eliminação entra em vigor num curto período de tempo (aproximadamente cinco minutos).