Gérer les catégories de développeurs

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

Une catégorie de développeur est un regroupement de développeurs ou d'entreprises ayant des caractéristiques similaires qui vous permet de configurer la monétisation pour qu'elle fonctionne sur cette catégorie spécifique. Par exemple, vous pouvez créer des plans tarifaires qui s'appliquent à tous les développeurs qui développent des applications pour le partage des revenus. Pour ce faire, créez une catégorie de développeurs appelée "partage des revenus" et ajoutez-y 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.

Ajouter une catégorie de développeurs

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

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

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 des développeurs.
3. Cliquez sur Modifier sur la page de la société.
4. Sélectionnez la catégorie de développeur pour l'entreprise.
5. Cliquez sur Enregistrer.
   

Modifier une catégorie de développeur

Pour modifier une catégorie de développeur dans l'interface utilisateur:

1. Accédez à la page Développer des catégories.
2. Placez le curseur sur la catégorie de développeur que vous souhaitez modifier, puis cliquez sur .
3. Saisissez la catégorie du développeur.
4. Cliquez sur Mettre à jour la catégorie de développeur.

Supprimer une catégorie de développeur

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

1. Accédez à la page Développer des catégories.
2. Placez le curseur sur la catégorie de développeur 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éveloppeur à 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 émettez la requête, vous spécifiez les catégories 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 requête POST 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 concerné, envoyez une requête PUT aux ressources suivantes:

• /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 MINT_DEVELOPER_CATEGORY en tant qu'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 existant à la catégorie de développeur nommée "Gold", qui a l'ID 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.

Pour afficher une catégorie de développeurs spécifique, envoyez une requête GET à /mint/organizations/{org_name}/developer-categories/{category_id}, où {category_id} correspond à l'identification de la catégorie de développeur (l'ID est renvoyé dans la réponse lorsque vous ajoutez la catégorie de développeur). 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éveloppeur à l'aide de l'API

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

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éveloppeur à l'aide de l'API

Pour supprimer une catégorie de développeur, envoyez une requête DELETE à /mint/organizations/{org_name}/developer-categories/{category_id}, où {category_id} correspond à l'identification de la catégorie de développeur à 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éfinie sur MINT_DEVELOPER_CATEGORY.	N/A	Oui
value	ID de la catégorie de développeurs à laquelle le développeur a été ajouté.	N/A	Oui, pour définir la catégorie de développeur.