<ph type="x-smartling-placeholder"></ph>
Vous consultez la documentation Apigee Edge.
Accédez à la page
Documentation sur Apigee X. En savoir plus
Si vous souhaitez avoir plus de contrôle sur les entreprises et les développeurs qui participent à vos campagnes monétisées programme d'API. Par exemple, si vous souhaitez créer des entreprises et des développeurs en interne pour à des fins de test. Vous pouvez créer manuellement des entreprises et des développeurs à l'aide de l'UI de gestion. et l'API.
Pour déterminer si vous devez créer manuellement des entreprises et des développeurs, si les développeurs ont besoin d'identifiants pour se connecter à l'interface utilisateur de gestion, envoyez identifiants dans les appels à l'API de gestion Edge ou connectez-vous à un portail des développeurs.
- Si vos développeurs de monétisation ont besoin d'identifiants de connexion pour accéder à l'interface utilisateur ou à l'API Edge, ils doivent d'abord disposer de leurs propres Compte d'administrateur Apigee.
- Si vous devez simplement créer des développeurs de test qui n'ont pas besoin d'identifiants (par exemple, si si vous souhaitez effectuer des appels d'API avec des développeurs de test fictifs), aucun compte Apigee n'est obligatoire.
Gérer les développeurs d'applications à l'aide de l'interface utilisateur
Créez, gérez et activez des développeurs d'applications à l'aide de l'interface utilisateur Edge, comme décrit dans la section Gestion des développeurs d'applications. Une fois les développeurs d'applications créés, vous pouvez les ajouter à des entreprises, comme décrit dans les sections suivantes.
Gérer des entreprises à l'aide de l'interface utilisateur
Créer, gérer et activer des entreprises, comme décrit dans les sections suivantes.
Explorer la page "Entreprises"
Accédez à la page "Sociétés", comme décrit ci-dessous.
Edge
Pour accéder à la page "Sociétés" à l'aide de l'interface utilisateur Edge:
- Connectez-vous à apigee.com/edge.
- Sélectionnez Publier > Monétisation > Sociétés dans la barre de navigation de gauche.
La page "Sociétés" s'affiche.
Comme le montre la figure, la page "Entreprises" vous permet de:
- Afficher les informations récapitulatives de toutes les entreprises, y compris leur nom, leur ID d'enregistrement, le nombre d'applications enregistrées et de clés API, le type de facturation, le nombre de développeurs attribués à l'entreprise et l'état
- Ajouter une entreprise
- Activer ou désactiver une entreprise
- Modifier une entreprise
- Supprimer une entreprise
- Rechercher dans la liste d'entreprises
Classic Edge (cloud privé)
Pour accéder à la page "Sociétés" à l'aide de l'interface utilisateur Edge classique:
- Connectez-vous à
http://ms-ip:9000
, où ms-ip est le Adresse IP ou nom DNS du nœud du serveur de gestion. - Sélectionnez Publier > Sociétés dans la barre de navigation supérieure.
La page "Sociétés" s'affiche.
- Afficher la liste actuelle des entreprises
- Gérez une entreprise. Plus précisément, ajoutez, activez, modifiez et supprimez une entreprise.
- Afficher le portail des développeurs connecté (Drupal 7 uniquement)
Ajouter une entreprise
Pour ajouter une entreprise:
- Accédez à la page "Sociétés".
- Cliquez sur + Entreprise.
- Saisissez les informations sur l'entreprise.
Les champs obligatoires incluent :
- Nom de l'entreprise
- Administrateur (l'utilisateur principal de l'entreprise administrateur)
- Type de facturation
Selon la configuration de la facturation de la monétisation, le type de facturation peut être défini par défaut sur
PREPAID
ouPOSTPAID
. Pour en savoir plus, consultez Configurer les types de facturation prépayé et post-payé à l'aide de l'API. - Ajoutez un ou plusieurs développeurs à l'entreprise.
- Dans la section "Developers" (Développeurs), saisissez une chaîne dans le champ Add Developer (Ajouter un développeur) pour afficher la liste des développeurs correspondant à la chaîne.
- Sélectionnez un développeur dans la liste déroulante.
- Répétez l'opération pour ajouter d'autres développeurs à l'entreprise.
- Ajoutez un ou plusieurs attributs personnalisés.
- Dans la section "Attributs personnalisés", cliquez sur + Nouveau.
- Saisissez le nom et la valeur de l'attribut personnalisé.
- Répétez l'opération pour ajouter d'autres attributs personnalisés à l'entreprise.
- Cliquez sur Créer une entreprise.
Activation et désactivation d'une entreprise
Pour activer et désactiver une société:
- Accédez à la page "Entreprise".
- Placez le curseur sur la société que vous souhaitez activer, puis activez dans le menu d'actions.
Désactivez l'option pour désactiver l'entreprise.
Modifier une entreprise
Pour modifier les données d'une société:
- Accédez à la page "Entreprise".
- Placez le curseur sur la société que vous souhaitez modifier, puis cliquez sur dans le menu d'actions.
- Mettez à jour les informations sur l'entreprise si nécessaire.
- Cliquez sur Modifier l'entreprise pour enregistrer les modifications.
Supprimer une entreprise
Pour supprimer une entreprise:
- Accédez à la page "Sociétés".
- Placez le curseur sur la société que vous souhaitez supprimer, puis cliquez sur dans le menu d'actions.
- Cliquez sur Supprimer pour confirmer la suppression.
Gérer des entreprises et des développeurs à l'aide de l'API
Les sections suivantes décrivent comment utiliser l'API pour gérer des entreprises et des développeurs.
Créer et mettre à jour des entreprises et des développeurs à l'aide de l'API
Pour gérer les entreprises et les développeurs avec l'API de gestion d'API Edge, reportez-vous aux sections suivantes de l'API:
- Créer une entreprise
- Créer un développeur
Remarque: Configurez les informations de monétisation lorsque vous créez un compte de développeur en transmettant des attributs personnalisés. - Ajoutez ou
informer les développeurs de l'entreprise
Remarque: Vous pouvez éventuellement attribuer un rôle au développeur, bien que ce ne soit pas obligatoire. Pour obtenir une liste Pour en savoir plus, consultez la section Récupérer des rôles de développeur. - Répertorier la configuration de la monétisation pour tous les développeurs ou pour un seul développeur
Remarque: Définissez les informations de monétisation en transmettant des attributs personnalisés lorsque créer ou mettre à jour un développeur. Vous pouvez afficher les attributs personnalisés de monétisation définis à l'aide de l'API standard (et non de monétisation) pour lister tous les développeurs ou un seul développeur.
Gérer les rôles de développeur à l'aide de l'API
Vous pouvez créer des rôles à l'aide des API de monétisation. Cela vous permet d'attribuer des rôles partenaires. Par exemple, vous pouvez définir des rôles d'administrateur et de développeur d'applications pour partenaire. Ces rôles peuvent ensuite être attribués à des employés de partenaire spécifiques.
Créer un rôle de développeur
Pour créer un rôle de développeur, envoyez une requête POST à
organizations/{org_name}/developer-roles
Lorsque vous faites
la demande, vous devez
spécifiez dans le corps de la requête le nom et la description du rôle, ainsi que l'identification
organisation. Exemple :
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "appDeveloper", "description": "App Developer", "organization": { "id": "{org_name}" } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \ -u email:password
Récupérer des rôles de développeur
Pour récupérer des rôles de développeur, envoyez une demande GET à "organizations/{org_id}/developer-roles". Exemple :
$ curl -H "Accept:application/json" -X GET \ "https:// api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \ -u email:password
La réponse doit se présenter comme suit (seule une partie de la réponse est affichée) :
{ "description" : "App Developer", "id" : "appdeveloper", "name" : "appDeveloper", "organization" : { ... } }
Paramètres de configuration du rôle de développeur pour l'API
Les options de configuration du rôle de développeur suivantes sont exposées à l'API:
Nom | Description | Par défaut | Obligatoire ? |
---|---|---|---|
name |
Nom du rôle de développeur. |
N/A | Oui |
description |
Description du rôle de développeur. |
N/A | Oui |
Récupérer le taux de taxe pour un développeur à l'aide de l'API
Vous pouvez obtenir le taux de taxe actuel pour un développeur en envoyant une demande GET à
organizations/{org_name}/tax-engine
Lorsque vous envoyez la requête, vous devez spécifier
l'identification du développeur
en tant que paramètre de requête. Exemple :
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tax-engine?developerId=dev7@myorg.com" \ -u email:password
La réponse doit se présenter comme suit :
0.09
Effectuer d'autres tâches spécifiques aux développeurs à l'aide de l'API
La plupart des tâches liées à la monétisation que vous pouvez effectuer pour une organisation, comme des plans tarifaires ou des conditions de notification, vous pouvez également développeur. Par exemple, vous pouvez créer un compte bancaire pour un développeur spécifique ou générer un le rapport sur les revenus pour un développeur spécifique.
Le tableau suivant répertorie les tâches spécifiques aux développeurs que vous pouvez effectuer à l'aide de de monétisation. Vous y trouverez également des instructions détaillées ces tâches.
Tâche | Emplacement des instructions |
---|---|
Afficher les conditions d'utilisation acceptées par un développeur | |
Afficher les packages d'API acceptés par un développeur |
Afficher les lots de produits API acceptés par un développeur ou une entreprise utilisant l'API |
Créer un plan tarifaire développeur | |
Afficher les forfaits disponibles pour un développeur | |
Affichez les plans tarifaires disponibles pour un développeur spécifique contenant produit |
Afficher un plan tarifaire accepté pour un développeur contenant un produit API utilisant l'API |
Afficher uniquement les forfaits développeur acceptés |
Afficher tous les plans tarifaires acceptés par un développeur utilisant l'API |
Émettre un crédit pour un développeur | |
Définir une limite de crédit pour un développeur | |
Afficher une limite de crédit pour les développeurs | |
"Créditer" (Ajouter un montant) à la réserve prépayée d'un développeur | |
Afficher la réserve prépayée d'un développeur | |
Configurer une condition de notification pour un développeur |
Configurer les notifications à l'aide de modèles de notification |
Créer et afficher les définitions de rapport d'un développeur |