Gérer les catégories de développeurs

Vous consultez la documentation Apigee Edge.
Accédez à la documentation**Apigee X**.
info

Une catégorie de développeurs est un regroupement de développeurs ou d'entreprises présentant des caractéristiques similaires. Elle vous permet de configurer la monétisation pour qu'elle s'applique à cette catégorie spécifique. Par exemple, vous pouvez créer des plans tarifaires qui s'appliquent à tous les développeurs qui créent des applications pour le partage des revenus en créant une catégorie de développeurs appelée "revenue_sharing" et en y ajoutant des développeurs. Pour en savoir plus sur la création de plans tarifaires avec des catégories de développeurs, consultez Créer des plans tarifaires.

Explorer la page "Catégories de développeurs"

Accédez à la page "Catégories de développeurs" à l'aide de l'interface utilisateur Edge ou de l'interface utilisateur Classic Edge, comme décrit dans les sections suivantes.

Interface utilisateur Edge

Pour accéder à la page "Catégories de développeurs" :

  1. Connectez-vous à apigee.com/edge.
  2. Sélectionnez Publier > Monétisation > Catégories de développeurs dans la barre de navigation de gauche.

La page "Catégories de développeurs" s'affiche.

Comme indiqué dans l'illustration, la page "Catégories de développeurs" vous permet d'effectuer les opérations suivantes :

Classic Edge (Private Cloud)

Pour accéder à la page "Catégories de développeurs" à l'aide de l'interface utilisateur Classic Edge :

  1. Connectez-vous à http://ms-ip:9000, où ms-ip est l' adresse IP ou le nom DNS du nœud de serveur de gestion.
  2. Sélectionnez Publier > Catégories de développeurs dans la barre de navigation supérieure.

La page "Catégories de développeurs" s'affiche.

La page "Catégories de développeurs" vous permet d'effectuer les opérations suivantes :

Ajouter une catégorie de développeurs

Pour ajouter une catégorie de développeurs à l'aide de l'interface utilisateur :

  1. Accédez à la page "Catégories de développeurs".
  2. Cliquez sur + Catégorie de développeurs.
  3. Saisissez un nom pour la nouvelle catégorie et une brève description.
  4. Cliquez sur Créer une catégorie de développeurs.

Ajouter une entreprise à une catégorie de développeurs

Ajoutez une entreprise à une catégorie de développeurs. Une entreprise ne peut appartenir qu'à une seule catégorie de développeurs.

Pour ajouter une entreprise à une catégorie de développeurs :

  1. Sélectionnez Publier > Entreprises dans la barre de navigation supérieure.
  2. Sélectionnez l'entreprise que vous souhaitez ajouter à la catégorie de développeurs.
  3. Cliquez sur Modifier sur la page de l'entreprise.
  4. Sélectionnez la catégorie de développeurs pour l'entreprise.
  5. Cliquez sur Enregistrer.

Modifier une catégorie de développeurs

Pour modifier une catégorie de développeurs à l'aide de l'interface utilisateur :

  1. Accédez à la page "Catégories de développeurs".
  2. Placez le curseur sur la catégorie de développeurs que vous souhaitez modifier, puis cliquez sur .
  3. Saisissez la catégorie de développeurs.
  4. Cliquez sur Mettre à jour la catégorie de développeurs.

Supprimer une catégorie de développeurs

Pour supprimer une catégorie de développeurs à l'aide de l'interface utilisateur :

  1. Accédez à la page "Catégories de développeurs".
  2. Placez le curseur sur la catégorie de développeurs que vous souhaitez modifier.
  3. Cliquez sur .
  4. Cliquez sur Supprimer pour confirmer l'opération.

Gérer les catégories de développeurs à l'aide de l'API

Gérez les catégories de développeurs à l'aide de l'API, comme décrit dans les sections suivantes.

Ajouter une catégorie de développeurs à l'aide de l'API

Ajoutez une catégorie de développeurs en envoyant une requête POST à /mint/organizations/{org_name}/developer-categories.

Lorsque vous envoyez la requête, vous devez spécifier la catégorie name et description dans la charge utile. Exemple :

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories" \
  -H "Content-Type:application/json"  \
  -d '{
    "name": "Gold",
    "description": "Gold membership"
  }' \
  -u email:password

La réponse doit se présenter comme suit :

{
  "description" : "Gold membership",
  "id" : "aa6f960a-d9fd-416e-be39-c071418aabd0",
  "name" : "Gold"
}

Ajouter un développeur ou une entreprise à une catégorie de développeurs à l'aide de l'API

Ajoutez un développeur ou une entreprise à une catégorie de développeurs lorsque vous ajoutez ou modifiez l'entreprise ou le développeur en envoyant une POST requête aux ressources suivantes, respectivement :

  • /organizations/{org_name}/companies
  • /organizations/{org_name}/developers

Pour ajouter un développeur ou une entreprise à une catégorie de développeurs lorsque vous modifiez l'entreprise ou le développeur, envoyez une PUT requête aux ressources suivantes, respectivement :

  • /organizations/{org_name}/companies/{company_id}
  • /organizations/{org_name}/developers/{developer_id}

Une entreprise ou un développeur ne peut appartenir qu'à une seule catégorie de développeurs.

Spécifiez le MINT_DEVELOPER_CATEGORY comme attribut dans le corps de la requête, avec l' ID interne de la catégorie comme valeur. Par exemple, la requête suivante ajoute un développeur déjà existant à la catégorie de développeurs nommée "Gold", dont l'ID est aa6f960a-d9fd-416e-be39-c071418aabd0.

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/K4jW2QLjZ1h8GFA8" \
  -H "Content-Type: application/json" \
  -d '{
   "email" : "developer@apigee.com",
    "developerId" : "K4jW2QLjZ1h8GFA8",
    "firstName" : "Dev",
    "lastName" : "One",
    "userName" : "devone",
    "attributes" : [ {
      "name" : "MINT_REGISTRATION_ID",
      "value" : "dev1"
    }, {
      "name" : "MINT_DEVELOPER_LEGAL_NAME",
      "value" : "DEV ONE"
    }, {
      "name" : "MINT_DEVELOPER_TYPE",
      "value" : "TRUSTED"
    }, {
      "name" : "MINT_BILLING_TYPE",
      "value" : "PREPAID"
    }, {
      "name" : "MINT_IS_BROKER",
      "value" : "TRUE"
    }, {
      "name" : "MINT_DEVELOPER_CATEGORY",
      "value" : "aa6f960a-d9fd-416e-be39-c071418aabd0"
    }, {
      "name" : "MINT_DEVELOPER_ADDRESS",
      "value" : "{
                   "address1": "Dev One Address",
                   "city": "Pleasanton",
                   "country": "US",
                   "isPrimary": "true",
                   "state": "CA",
                   "zip": "94588"
                }"
    }
  }' \
  -u email:password

Afficher les catégories de développeurs à l'aide de l'API

Affichez une catégorie de développeurs spécifique ou toutes les catégories de développeurs d'une organisation.

Affichez une catégorie de développeurs spécifique en envoyant une requête GET à /mint/organizations/{org_name}/developer-categories/{category_id}, où {category_id} est l'identification de la catégorie de développeurs (l'ID est renvoyé dans la réponse lorsque vous ajoutez la catégorie de développeurs). Exemple :

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \
  -H "Accept:application/json" \
  -u email:password

Affichez toutes les catégories de développeurs d'API pour une organisation en envoyant une requête GET à /mint/organizations/{org_id}/developer-categories. Exemple :

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories" \
  -H "Accept:application/json" \
  -u email:password

Modifier une catégorie de développeurs à l'aide de l'API

Modifiez une catégorie de développeurs en envoyant une requête PUT à /mint/organizations/{org_name}/developer-categories/{category_id}, où {category_id} est l'identification de la catégorie à mettre à jour. Vous devez spécifier dans le corps de la requête les paramètres mis à jour et l'ID de la catégorie de développeurs. Par exemple, la requête suivante modifie la description d'une catégorie de développeurs :

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \
  -H "Content-Type: application/json"  \
  -d '{
    "id": "aa6f960a-d9fd-416e-be39-c071418aabd0",
    "description": "Premium membership"
  }' \
  -u email:password

Supprimer une catégorie de développeurs à l'aide de l'API

Supprimez une catégorie de développeurs en envoyant une requête DELETE à /mint/organizations/{org_name}/developer-categories/{category_id}, où {category_id} est l'identification de la catégorie de développeurs à supprimer. Exemple :

curl -X DELETE "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \
  -H "Accept:application/json" \
  -u email:password

Propriétés de configuration des catégories de développeurs pour l'API

Le tableau suivant récapitule les propriétés de configuration qui peuvent être définies à l'aide de l'API.

Nom Description Par défaut Obligatoire ?
name

Nom de propriété Défini sur MINT_DEVELOPER_CATEGORY.

N/A Oui
value

ID de la catégorie de développeurs à laquelle le développeur est ajouté.

N/A Oui, afin de définir la catégorie de développeurs.