Révoquer et approuver des clés d'application de développeur

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

Cet article explique comment utiliser l'UI et les API pour révoquer ou approuver les clés API d'applications de développeur et des produits qu'elles contiennent.

Utiliser l'UI pour révoquer la clé d'un produit d'API spécifique dans une application de développeur

Vous pouvez révoquer la clé associée à un produit d'API spécifique via l'UI. Il en résulte que les ressources d'API définies dans ce produit d'API ne seront plus accessibles, sauf si la clé est de nouveau approuvée.

Pour révoquer la clé à l'aide de l'UI Apigee, procédez comme suit :

Ouvrez l'interface utilisateur Apigee.
Sélectionnez Publier > Applications dans la barre de navigation de gauche.
Sélectionnez l'application contenant la clé que vous souhaitez révoquer.
Cliquez sur l'icône de modification .
Dans la section "Identifiants", sélectionnez Révoquer dans le menu déroulant "État".

Conseil : Vous pouvez utiliser l'API Get Developer App Details pour obtenir la représentation JSON d'une application de développeur afin de connaître l'état d'approbation des produits dans cette application. Dans la représentation JSON suivante d'une application de développeur, vous pouvez voir où le produit d'API appelé "Weather-Product" a été révoqué :

{
  "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"
        }
      ],
      "attributes": [],
      "consumerKey": "giIC9Au6XP82wJ1oxZuQU4L75OdNKLhb",
      "consumerSecret": "SXg8JizqeTA8j3gX",
      "expiresAt": -1,
      "issuedAt": 1415728893154,
      "scopes": [],
      "status": "approved"
    }
  ],
  "developerId": "Z2S37rxX2Suzkwtg",
  "lastModifiedAt": 1420682967414,
  "lastModifiedBy": "wwitman@apigee.com",
  "name": "AnotherTestApp",
  "scopes": [],
  "status": "approved"
}

Utiliser l'UI pour approuver la clé d'un produit d'API spécifique dans une application de développeur

Vous pouvez approuver une clé client précédemment révoquée pour un produit d'API dans une application de développeur via l'UI Apigee. L'application cliente pourra à nouveau accéder aux API dans ce produit.

Pour approuver une clé de produit d'API, procédez comme suit :

Ouvrez l'interface utilisateur Apigee.
Dans le menu principal, sélectionnez Publish > Apps (Publier > Applications).
Dans la liste des applications, sélectionnez celle qui contient la clé que vous souhaitez approuver.
Cliquez sur l'icône de modification .
Dans la section "Credentials" (Identifiants), sélectionnez l'option Approve (Approuver) du menu déroulant "Status" (État).

Révoquer et approuver des clés pour les produits d'API avec l'API Apigee

Apigee fournit des API vous permettant de gérer l'état des clés API en fonction de votre cas d'utilisation. Dans le code JSON de l'application de développeur ci-dessous, l'emplacement de chaque option d'approbation/de révocation est indiqué pour chacun des trois cas suivants :

(1) Indique l'état des clés d'un produit API spécifique dans une application de développeur. Cette API effectue exactement les opérations UI décrites précédemment dans cet article. Reportez-vous à l'API permettant d'approuver ou de révoquer la clé client d'une application.
(2) Indique l'état de la clé d'une application de développeur. Si vous révoquez la clé, l'application ne peut plus l'utiliser pour accéder à une API. Tous les jetons d'accès associés à une clé d'application révoquée restent actifs, mais Apigee vérifie d'abord l'état de cette clé. Si l'état est défini sur "révoqué", Apigee n'autorise pas l'appel. Reportez-vous à l'API permettant d'approuver ou de révoquer une clé API pour une application de développeur.
(3) Indique l'état de toutes les clés associées à une application de développeur. Une application révoquée ne peut accéder à aucun produit d'API et ne peut pas appeler une API gérée par Apigee. Reportez-vous à l'API permettant d'approuver ou de révoquer toutes les clés d'une application de développeur.

{
  "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)
}