Gerenciar produtos de API

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

Gerencie produtos de API usando a IU de gerenciamento do Apigee Edge, conforme descrito nesta seção. Para gerenciar o produto de API usando a API, consulte Como usar a API de gerenciamento de borda publicar APIs.

Para ter uma visão geral dos produtos de API, consulte O que é um produto de API?

Explore a página de produtos de API

Acesse a página de produtos da API, conforme descrito abaixo.

Como adicionar um produto de API

Adicione um produto de API usando a interface, conforme descrito abaixo. Para usar a API Edge, consulte Como configurar produtos de API usando a API.

Para adicionar um produto de API usando a interface do Edge:

1. Acesse a página de produtos de API, conforme descrito anteriormente nesta seção.
2. Clique em +Produto da API.
3. Insira os detalhes do produto do produto de API.
   

   Campo	Descrição
   Nome	Nome interno do produto de API. Não é possível editar o nome depois que o produto da API é criado. Não especifique caracteres especiais no nome.
   Nome de exibição	Nome de exibição do produto de API. O nome de exibição é usado na IU e você pode editá-lo a qualquer momento. Se não for especificado, o valor Nome será usado. Esse campo é preenchido automaticamente com o valor do nome. você pode editar ou excluir o conteúdo. O nome de exibição pode incluir caracteres especiais.
   Descrição	Descrição do produto de API.
   Ambiente	Ambientes em que o produto de API permitirá acesso. Por exemplo, test ou prod.
   Acesso	Nível de acesso. Para detalhes, consulte Nível de acesso.
   Aprovar automaticamente solicitações de acesso	Ativar a aprovação automática das solicitações de chave deste produto de API em qualquer app. Para exigir a aprovação manual das chaves, desative esta opção. Consulte Como registrar apps e gerenciar chaves de API (interface) e Chaves de app do desenvolvedor (API).
   Cota	Limite de cota que você quer referenciar nas políticas de cota. Inserir um valor de cota não impõe automaticamente as restrições ao número de chamadas que podem ser feitas por meio do produto. Os proxies de API referenciados pelo produto precisam incluir a política de cotas para aplicar a cota. Para mais informações, consulte Cotas.
   Escopos do OAuth permitidos	Se você estiver usando OAuth com o produto de API, permita os escopos OAuth que quiser que o produto de API permita, como leitura ou outros escopos que os aplicativos enviarão com suas chamadas de API. Especifique vários escopos como uma lista separada por vírgulas. Consulte os escopos do OAuth.

4. Adicione os recursos da API disponíveis no produto da API, incluindo os proxies de API e os caminhos dos recursos.

   Por exemplo, se você adicionar um proxy de API "de música" ao produto com um caminho base de /music, o produto de API permitirá chamadas para /music. No entanto, se você quiser que o produto de API permita acesso apenas ao caminho do recurso venues, que tem um URI de /music/venues, adicione o caminho do recurso /venues ao produto. Nesse caso, as chamadas para /music/venues?name=paramount são permitidas, mas as chamadas para /music/artists?name=Jack%Johnson são bloqueadas.

   Defina um caminho de recurso específico ou defina o caminho base e todos os subcaminhos específicos, especificando o caminho do recurso como /. O caminho do recurso pode incluir os caracteres curinga /** e /*. O asterisco curinga duplo indica que todos os subcaminhos do caminho base são suportados (mas não o caminho base). Um único asterisco indica que apenas URIs um nível abaixo do caminho base são compatíveis. Consulte Como configurar o comportamento do caminho do recurso "/", "/*" e "/**", conforme descrito mais adiante nesta seção.

   Para adicionar recursos de API:

   1. Clique em Adicionar um proxy ou Adicionar um caminho na seção de recursos da API.
   2. Escolha se você quer adicionar um proxy de API, um caminho ou ambos: proxy e caminho da API.

      

   3. Adicione um ou mais proxies de API e caminhos de recursos.

      Observe o seguinte:

      • Os caminhos de recursos que você define se aplicam a todos os proxies de API adicionados ao produto da API.
      • Caminhos de recurso mais inclusivos e menos específicos têm precedência sobre aqueles mais específicos. Por exemplo, se você adicionar / e /**, o caminho do recurso / terá precedência. o caminho do recurso /** será ignorado.

      Por exemplo:

      

   4. Clique em Adicionar ou Adicionar e iniciar outro para especificar recursos adicionais da API.
   .
5. (Opcional) Use a seção Destinos de serviço remoto da Apigee para vincular o produto a um ou mais destinos de serviço remoto. A menos que você esteja usando o adaptador da Apigee Envoy, ignore essa configuração. Para mais informações, consulte o Guia de operações do adaptador do Apigee Envoy.

6. (Opcional) Use a seção Atributos personalizados para adicionar até 18 atributos personalizados a um produto da API.

   Os atributos personalizados são pares de chave-valor que podem ser usados de várias maneiras, inclusive ajudando a controlar a execução do proxy da API. Por exemplo, é possível criar um atributo personalizado chamado deprecated com um valor verdadeiro ou falso. No fluxo do proxy de API, verifique o valor do atributo deprecated do produto de API (por exemplo, usando a variável verifyapikey.{policy_name}.apiproduct.deprecated que está disponível automaticamente depois de criar o atributo personalizado). Se o valor for verdadeiro (obsoleto), você poderá gerar um erro com a política de aumento de falhas.

7. Clique em Salvar.

Configuração do comportamento de um caminho de recurso de '/', '/*' e '/**'

A tabela a seguir descreve o comportamento padrão de um produto de API para caminhos de recurso diferentes. Neste exemplo, o proxy da API tem um caminho base de /v1/weatherapikey. O caminho do recurso do produto da API aplica-se ao sufixo do caminho após o caminho base.

URI da solicitação	Permitido para /	Permitido para /*	Permitido para /**	Permitido para /*/2/**	Permitido para /*/2/*
/v1/weatherapikey	S	N	N	N	N
/v1/weatherapikey/	S	N	N	N	N
/v1/weatherapikey/1	S	Y	S	N	N
/v1/weatherapikey/1/	S	Y	S	N	N
/v1/weatherapikey/1/2	S	N	S	N	N
/v1/weatherapikey/1/2/	S	N	S	S	N
/v1/weatherapikey/1/2/3/	S	N	S	Y	S
/v1/weatherapikey/1/a/2/3/	S	N	S	N	N

Por padrão, um caminho de recurso de / em um produto da é compatível com o caminho base e todos os subcaminhos. Por exemplo, se o caminho de base do proxy de API for /v1/weatherapikey, o produto de API aceitará solicitações para /v1/weatherapikey e para qualquer subcaminho, como /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA e assim por diante.

É possível alterar esse padrão para que um caminho de recurso de / corresponda apenas ao caminho base do proxy da API, o que significa que o produto da API não permitirá acesso a um URI que tenha nada após o /. Se você fizer essa alteração, na tabela acima, somente as duas primeiras linhas em "Permitido para /" conteriam "Y".

Para alterar o padrão, um administrador do sistema precisa definir o valor da propriedade features.isSingleForwardSlashBlockingEnabled na sua organização como true. Os clientes do Cloud podem fazer essa solicitação acesse o suporte do Apigee Edge.

Como editar um produto de API

Para editar um produto de API:

1. Acesse a página de produtos de API, conforme descrito anteriormente nesta seção.
2. Clique na linha do produto de API que você quer editar.
3. Clique em Editar na página do produto da API.
4. Edite os campos conforme necessário.

   Exclua recursos que você adicionou a um produto de API. Faça isso se um recurso não funcionar corretamente ou exigir mais desenvolvimento. Quando excluído, esse recurso não faz mais parte do produto da API. Os apps que usam o produto da API não podem mais acessar o recurso excluído. Os recursos excluídos são removidos do produto, mas não são excluídos do sistema. Por isso, eles ainda podem ser usados por outros produtos.

5. Clique em Salvar.

Com o Apigee Edge for Public Cloud, o Edge mantém entidades seguintes são armazenadas em cache por, no mínimo, 180 segundos após serem acessadas.

• Tokens de acesso do OAuth Isso significa que um token revogado ainda pode ser bem-sucedido por até três minutos, até que o limite de cache expire.
• Entidades de serviço de gerenciamento de chaves (KMS) (apps, desenvolvedores, produtos de API).
• Atributos personalizados em tokens OAuth e entidades KMS.

Como excluir um produto da API

Antes de excluir um produto de API, é necessário cancelar o registro/desassociar todos os apps de desenvolvedor associados ao produto. Para fazer isso, exclua os apps ou revogue as chaves de API.

Para excluir um produto de API:

1. Acesse a página de produtos de API, conforme descrito anteriormente nesta seção.
2. Posicione o cursor sobre o produto de API na lista.
3. Clique em .
4. Clique em Excluir para confirmar a operação de exclusão.