Vous consultez la documentation d'Apigee Edge.
Consultez la
documentation Apigee X. en savoir plus
Si vous souhaitez mieux contrôler les entreprises et les développeurs qui participent à votre programme d'API monétisé (par exemple, si vous souhaitez créer des entreprises et des développeurs internes à des fins de test), vous pouvez créer des entreprises et des développeurs manuellement à l'aide de l'interface utilisateur de gestion et de l'API.
L'une des principales considérations qui détermine si vous devez créer des entreprises et des développeurs manuellement est de savoir si les développeurs auront besoin ou non d'identifiants pour se connecter à l'interface utilisateur de gestion, envoyer des identifiants lors des appels à l'API de gestion Edge ou se connecter à un portail des développeurs.
- Si vos développeurs de solutions 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 leur propre compte administrateur Apigee.
- Si vous devez simplement créer des développeurs de test qui n'ont pas besoin d'identifiants (par exemple, si vous souhaitez effectuer des appels d'API avec des développeurs de test fictifs), aucun compte Apigee n'est requis.
Gérer les développeurs d'applications à l'aide de l'UI
Créez, gérez et activez des développeurs d'applications à l'aide de l'interface utilisateur Edge, comme décrit dans Gérer les 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'UI
Créez, gérez et activez 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.
Périphérie
Pour accéder à la page Entreprises à l'aide de l'interface utilisateur Edge:
- Connectez-vous à apigee.com/edge.
- Sélectionnez Publier > Monétisation > Entreprises 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 des informations récapitulatives pour toutes les entreprises, y compris le nom de l'entreprise, l'identifiant 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 son statut
- Ajouter une entreprise
- Activer ou désactiver une entreprise
- Modifier une entreprise
- Supprimer une entreprise
- Rechercher dans la liste des entreprises
Classic Edge (cloud privé)
Pour accéder à la page "Entreprises" à l'aide de l'interface utilisateur Classic Edge:
- Connectez-vous à
http://ms-ip:9000
, où ms-ip correspond à l'adresse IP ou au nom DNS du nœud du serveur de gestion. - Sélectionnez Publier > Entreprises dans la barre de navigation supérieure.
La page "Sociétés" s'affiche.
- Afficher la liste actuelle des entreprises
- Gérer 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 société:
- 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 (utilisateur qui est l'administrateur principal de l'entreprise)
- 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ée et post-payée à l'aide de l'API. - Ajoutez un ou plusieurs développeurs à l'entreprise.
- Dans la section "Développeurs", saisissez une chaîne dans le champ 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 entreprise:
- Accédez à la page "Entreprise".
- Placez le curseur sur l'entreprise que vous souhaitez activer, puis activez dans le menu d'actions.
Désactivez le bouton pour désactiver l'entreprise.
Modifier une entreprise
Pour modifier une société:
- Accédez à la page "Entreprise".
- Placez le curseur sur la société à modifier, puis cliquez sur dans le menu d'actions.
- Mettez à jour les informations sur l'entreprise, si nécessaire.
- Cliquez sur Mettre à jour l'entreprise pour enregistrer les modifications.
Supprimer une entreprise
Pour supprimer une société:
- Accédez à la page "Sociétés".
- Placez le curseur sur la société à supprimer et cliquez sur dans le menu d'actions.
- Cliquez sur Supprimer pour confirmer la suppression.
Gérer des entreprises et des développeurs utilisant l'API
Gérer des entreprises et des développeurs avec l'API est décrit dans les sections suivantes.
Créer et actualiser des entreprises et des développeurs à l'aide de l'API
Pour gérer des entreprises et des développeurs avec l'API de gestion API Edge, consultez les 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 développeur en transmettant des attributs personnalisés. - Ajouter ou mettre à jour des développeurs d'entreprise
Remarque: Vous pouvez éventuellement attribuer un rôle au développeur, bien que ce ne soit pas obligatoire. Pour obtenir la liste des rôles de développeur, consultez la section Récupérer des rôles de développeur. - Répertoriez 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 lors de la création ou de la mise à jour d'un développeur. Vous pouvez afficher les attributs personnalisés de monétisation définis à l'aide de l'API standard (hors monétisation) pour répertorier 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. Vous pouvez ainsi définir des rôles pour vos partenaires. Par exemple, vous pouvez définir les rôles d'administrateur et de développeur d'applications pour un 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 envoyez la requête, vous devez spécifier le nom et la description du rôle ainsi que l'identification de l'organisation dans le corps de la requête. 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 les rôles de développeur
Pour récupérer les 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 des rôles 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
Pour obtenir le taux de taxe actuel d'un développeur, envoyez une requête 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 au développeur à l'aide de l'API
La plupart des tâches de monétisation que vous pouvez effectuer pour une organisation, comme la création de plans tarifaires ou la création de conditions de notification, peuvent également être effectuées pour un développeur individuel. Par exemple, vous pouvez créer le compte bancaire d'un développeur spécifique ou générer un 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 des API de monétisation. Le tableau liste également où vous pouvez trouver des instructions détaillées sur l'exécution de ces tâches.
Tâche | Où trouver les 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 d'API acceptés par un développeur ou une entreprise qui utilise l'API |
Créer un plan tarifaire pour les développeurs | |
Afficher les plans tarifaires disponibles pour un développeur | |
Afficher les plans tarifaires disponibles pour un développeur spécifique et contenant un produit spécifique |
Afficher un plan tarifaire accepté pour un développeur qui contient un produit API utilisant l'API |
Afficher uniquement les plans tarifaires pour les développeurs acceptés |
Afficher tous les plans tarifaires acceptés par un développeur à l'aide de l'API |
Émettre un crédit à un développeur | |
Définir une limite de crédit pour un développeur | |
Afficher la limite de crédit d'un développeur | |
"Créditer" (ajouter un montant) au solde prépayé d'un développeur | |
Afficher le solde prépayé d'un développeur | |
Configurer une condition de notification pour un développeur |
Configurer des notifications à l'aide de modèles de notification |
Créer et afficher des définitions de rapport pour un développeur |