Como revogar e aprovar chaves de apps do desenvolvedor

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

Este tópico explica como usar a interface e as APIs para revogar ou aprovar chaves de API para produtos em apps e apps de 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.

Revogue a chave, conforme descrito abaixo.

Edge

Para revogar a chave usando a IU do Edge:

  1. Faça login em apigee.com/edge.
  2. Selecione Publicar > Apps na barra de navegação à esquerda.
  3. Selecione o aplicativo que contém a chave que você quer revogar.
  4. Na página do app do desenvolvedor, clique em .
  5. Na seção "Credenciais", selecione Revogar no menu suspenso "Status".

Borda clássica (nuvem privada)

Para revogar a chave usando a IU clássica do Edge:

  1. Faça login em http://ms-ip:9000, em que ms-ip é o endereço IP ou o nome DNS do nó do servidor de gerenciamento.
  2. Selecione Publicar > Apps do desenvolvedor na barra de navegação superior.
  3. Na lista de aplicativos, selecione o que contém a chave que você quer revogar.
  4. Na página do app do desenvolvedor, clique em Editar.
  5. Na seção "Produtos", clique em Revogar para revogar a chave do produto.

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

Você pode aprovar uma chave do consumidor revogada anteriormente para um produto de API em um app de desenvolvedor por meio da interface de gerenciamento. Novamente, o app cliente poderá acessar as APIs nesse produto.

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

  1. Faça login na sua conta do Apigee Edge.
  2. No menu principal, selecione Publicar > Apps do desenvolvedor.
  3. Na lista de apps, selecione o que contém a chave que você quer aprovar.
  4. Na página do app do desenvolvedor, clique em Editar.
  5. Na seção "Produtos", clique em Aprovar para restabelecer a chave.

Como revogar e aprovar chaves de produtos de API com a API do Edge

O Edge fornece APIs que permitem gerenciar o status da chave de API, dependendo do seu 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) Revogar/aprovar chaves para produtos específicos de API em um app de desenvolvedor. Essa API faz exatamente o que as operações da IU descritas anteriormente neste tópico fazem. Consulte Aprovar ou revogar o produto de API de uma chave para um app do desenvolvedor.
  • (2) Revogar/aprovar uma chave específica para um aplicativo do desenvolvedor. A revogação da chave a torna inutilizável para que o aplicativo acesse uma API. Todos os tokens de acesso associados a uma chave de app revogada permanecerão ativos, mas o Apigee Edge verifica o status da chave de app primeiro. Se o status estiver definido como "revogado", o Apigee Edge não permitirá que a chamada seja processada. Consulte Aprovar ou revogar chave específica do app do desenvolvedor.
  • (3) Revogue/aprove o status da chave de API de todo um app do desenvolvedor. Um aplicativo revogado não pode acessar nenhum produto de API e não pode invocar nenhuma API gerenciada pelo Apigee Edge. Consulte Aprovar ou revogar o app de 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)
}