Como revogar e aprovar chaves de apps do desenvolvedor

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

Confira a documentação da Apigee Edge.

Este tópico explica como usar a interface e as APIs para revogar ou aprovar chaves de API para produtos em apps de desenvolvedores e em apps para desenvolvedores.

Como usar a IU para revogar a chave de um produto de API específico em um app do desenvolvedor

Revogue a chave associada a um produto de API específico através da IU. Como efeito, os recursos da API definidos nesse produto não estarão mais acessíveis, a menos que a chave seja novamente aprovada.

Para revogar a chave usando a IU da Apigee, siga estas etapas:

  1. Abra a IU da Apigee.
  2. Selecione Publicar > Apps na barra de navegação à esquerda.
  3. Selecione o aplicativo que contém a chave que você quer revogar.
  4. Clique no ícone de edição Imagem de um ícone de edição..
  5. Na seção "Credenciais", selecione Revogar no menu suspenso "Status".

Como usar a IU para aprovar a chave de um produto de API específico em um app do desenvolvedor

É possível aprovar uma chave de consumidor anteriormente revogada para um produto de API em um app do desenvolvedor por meio da IU da Apigee. Novamente, o app cliente poderá acessar as APIs nesse produto.

Para aprovar uma chave de produto de API, siga estas etapas:

  1. Abra a IU da Apigee.
  2. No menu principal, selecione Publicar > Apps.
  3. Na lista de aplicativos, selecione aquele que contém a chave que você quer aprovar.
  4. Clique no ícone de edição Imagem de um ícone de edição..
  5. Na seção "Credenciais", selecione Aprovar no menu suspenso "Status".

Como revogar e aprovar chaves de produtos de API com a API Apigee

A Apigee fornece APIs que permitem gerenciar o status da chave de API de acordo com o caso de uso. No JSON do app do desenvolvedor abaixo, o local de cada sinalização de aprovação/revogação é indicado para cada um destes três casos:

  • (1) Mostra o status principal de um produto específico da API em um aplicativo do desenvolvedor. Essa API faz exatamente o que as operações da IU descritas anteriormente neste tópico fazem. Consulte a API para aprovar ou revogar o token do cliente de um aplicativo.
  • (2) Mostra o status principal de uma chave de app do desenvolvedor. A revogação da chave a inutiliza para que o app a use para acessar uma API. Os tokens de acesso associados a uma chave de aplicativo revogada permanecerão ativos, mas a Apigee verificará o status da chave de aplicativo primeiro. Se o status for definido como "revogado", a Apigee não permitirá que a chamada seja concluída. Consulte a API sobre como aprovar ou revogar uma chave de API para um app de desenvolvedor.
  • (3) Mostra o status de todas as chaves associadas a um aplicativo do desenvolvedor. Um aplicativo revogado não pode acessar nenhum produto de API e não pode invocar nenhuma API gerenciada pela Apigee. Consulte a API para aprovar ou revogar todas as chaves de um app do desenvolvedor.
{
  "accessType": "",
  "appFamily": "default",
  "appId": "6ed3a4d1-4733-439a-80a4-0d71149ec9ad",
  "attributes": [
    {
      "name": "DisplayName",
      "value": "AnotherTestApp"
    },
    {
      "name": "Notes",
      "value": ""
    }
  ],
  "callbackUrl": "",
  "createdAt": 1415728893126,
  "createdBy": "wwitman@apigee.com",
  "credentials": [
    {
      "apiProducts": [
        {
          "apiproduct": "Weather-Product",
          "status": "revoked" // (1)
        }
      ],
      "attributes": [],
      "consumerKey": "giIC9Au6XP82wJ1oxZuQU4L75OdNKLhb",
      "consumerSecret": "SXg8JizqeTA8j3gX",
      "expiresAt": -1,
      "issuedAt": 1415728893154,
      "scopes": [],
      "status": "approved" // (2) 
    }
  ],
  "developerId": "Z2S37rxX2Suzkwtg",
  "lastModifiedAt": 1420682967414,
  "lastModifiedBy": "wwitman@apigee.com",
  "name": "AnotherTestApp",
  "scopes": [],
  "status": "approved" // (3)
}