Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info
Enregistrez et gérez vos développeurs d'applications comme décrit dans les sections suivantes. (L'enregistrement d'applications est un processus distinct, décrit dans l'article Enregistrer des applications et gérer les clés API).
Introduction
Edge offre de nombreux avantages qui dépendent complètement de l'élément qui appelle vos API. Par exemple, la sécurité des API, la gestion du trafic et une grande quantité de données d'analyse dépendent de l'élément qui appelle. Comment Edge sait-il qui appelle vos API ? En lisant les informations uniques de chaque appel d'API, tel qu'un ID d'utilisateur, une clé d'API ou un jeton OAuth. Ces informations uniques verrouillent ou déverrouillent la fonctionnalité que vous créez dans vos proxys d'API, ce qui vous permet de contrôler entièrement l'accès aux API et leur comportement.
C'est la raison pour laquelle les développeurs d'applications doivent s'inscrire afin d'utiliser vos API. Une fois ajoutés, les développeurs enregistrent leurs applications, sélectionnent les API qu'ils souhaitent utiliser et reçoivent les identifiants d'API uniques (clés et secrets du consommateur) nécessaires pour accéder à vos API.
Enregistrer des développeurs d'applications
Enregistrez les développeurs de l'application de l'une des manières suivantes :
- Si vous disposez d'un compte Edge payant, les développeurs peuvent s'auto-enregistrer via un portail des développeurs. Pour en savoir plus, consultez l'une des sections suivantes suivant le type de portail des développeurs souhaité :
- Portail intégré : Créer un compte de développeur sur le portail intégré
- Drupal 10: Enregistrer un compte de développeur d'applications
- Drupal 7: Ajouter et gérer des comptes utilisateur
- Les administrateurs peuvent inscrire des développeurs d'applications à l'aide de l'API.
- En tant qu'administrateur du portail des développeurs, gérez les développeurs directement sur votre portail, comme décrit dans les sections suivantes :
- Portail intégré: Gérez des comptes de développeur.
- Drupal 10: Comment les développeurs d'applications interagissent avec le module Apigee Edge
- Drupal 7: Ajouter et gérer des comptes utilisateur
- En tant qu'administrateur d'organisation, gérez les développeurs à l'aide de l'interface utilisateur ou de l'API d'Edge, comme décrit dans les sections suivantes.
Recommandations pour la gestion des comptes de développeur sur des portails de développeurs
Apigee vous recommande de gérer les comptes de développeur directement sur votre portail des développeurs.
Si vous utilisez le portail intégré, c'est le seul moyen de s'assurer que les comptes de développeur restent synchronisés entre le portail et Edge.
Si vous utilisez le portail des développeurs basé sur Drupal, la gestion des comptes de développeur directement sur le portail offre les avantages suivants :
- Lorsque vous ajoutez un développeur via l'interface d'administration du portail, vous pouvez définir son mot de passe pour le portail et déclencher l'envoi d'un e-mail automatique au développeur.
Lorsque vous ajoutez ou modifiez un développeur avec Edge, aucun e-mail n'est envoyé au développeur et vous ne pouvez pas définir son mot de passe sur le portail. Par conséquent, le développeur doit réinitialiser son mot de passe de portail avant de pouvoir s'y connecter.
- Toutes les modifications apportées au compte de développeur sur le portail sont automatiquement envoyées à Edge.
Si vous décidez de gérer des comptes de développeur basés sur Drupal à l'aide d'Edge, vous devez synchroniser les développeurs d'applications entre le portail et Edge.
Explorer la page Développeurs
Accédez à la page "Développeurs" et explorez-la à l'aide de l'interface utilisateur Edge et de l'interface utilisateur classique d'Edge.
Edge
Pour accéder à la page "Développeurs" à l'aide de l'interface utilisateur Edge:
- Connectez-vous à apigee.com/edge.
- Sélectionnez Publier > Développeurs dans la barre de navigation de gauche.
La page "Développeurs" s'affiche.
Comme le montre la figure, la page "Développeurs" vous permet de :
- Ajouter un développeur
- Afficher et modifier les détails du développeur, y compris ce qui suit :
- Exporter des données de publication
- Supprimer un développeur
- Effectuer une recherche dans la liste des développeurs
Edge classique (cloud privé)
Pour accéder à la page "Développeurs" à l'aide de l'interface utilisateur classique d'Edge:
- Connectez-vous à
http://ms-ip:9000
, où ms-ip est l'adresse IP ou le nom DNS du nœud de serveur de gestion. - Sélectionnez Publier > Développeurs dans la barre de navigation supérieure.
La page "Développeurs" s'affiche.
- Afficher la liste des développeurs
- Ajouter un développeur
- Afficher et modifier les informations du développeur, y compris les attributs personnalisés, et activer un développeur
- Exporter des données de publication
- Supprimer un développeur
- Effectuer une recherche dans la liste des développeurs
- Afficher le portail des développeurs associé (Drupal 7 uniquement)
Ajouter un développeur
Pour ajouter un développeur, procédez comme suit :
- Accéder à la page "Développeurs".
- Cliquez sur + Développeur.
- Saisissez les détails concernant le développeur, y compris ses prénom, nom, adresse e-mail et nom d'utilisateur.
- Cliquez sur Créer.
Afficher et modifier les informations du développeur
Affichez et modifiez les détails du développeur. Pour les organisations ayant activé la monétisation, vous pouvez modifier les attributs personnalisés de monétisation définis dans Configurer les attributs de monétisation.
Pour afficher et modifier les détails d'un développeur, procédez comme suit :
- Accéder à la page "Développeurs".
- Cliquez sur la ligne du développeur que vous souhaitez afficher et modifier pour ouvrir ses informations détaillées.
- Les informations suivantes s'affichent dans la section "Détails". Si nécessaire, modifiez les informations du développeur.
Détails Description Détails Prénom et nom, nom d'utilisateur et adresse e-mail du développeur ; état de l'enregistrement et durée ; ID du développeur.
Pour modifier les informations du développeur, cliquez dans l'un des champs suivants :- Prénom
- Nom
- Nom d'utilisateur
Attributs personnalisés Attributs personnalisés définis pour le développeur. Configurez les attributs personnalisés, si nécessaire. Pour en savoir plus, consultez : Applications Applications enregistrées par le développeur. Consultez la section Enregistrer des applications. - Le champ "État" vous permet d'activer ou désactiver le développeur.
Pour en savoir plus, consultez la section Activer et désactiver un développeur.
Avec Apigee Edge pour le cloud public, Edge conserve les entités suivantes en cache pendant au moins 180 secondes après l'accès aux entités.
- Jetons d'accès OAuth. Cela signifie qu'un jeton révoqué peut toujours fonctionner jusqu'à trois minutes, jusqu'à ce que sa limite de cache expire.
- Entités du service de gestion des clés (KMS) (Applications, développeurs, produits d'API).
- Attributs personnalisés sur les jetons OAuth et les entités KMS.
Gérer les attributs personnalisés d'un développeur
Ajoutez jusqu'à 18 attributs personnalisés pour chaque développeur, y compris les attributs de monétisation décrits dans Configurer les attributs de monétisation.
Pour gérer les attributs personnalisés, procédez comme suit :
- Accéder à la page "Développeurs".
- Cliquez sur la ligne du développeur pour lequel vous souhaitez gérer les attributs personnalisés afin d'ouvrir les informations le concernant.
- Cliquez sur + dans la section "Attributs personnalisés".
- Saisissez le nom et la valeur de l'attribut.
- Cliquez sur .
- Pour supprimer un attribut personnalisé, placez votre curseur sur l'attribut et cliquez sur dans le menu d'actions.
Activer et désactiver un développeur
Lorsqu'un développeur d'applications s'enregistre automatiquement sur votre portail, vous pouvez décider s'il est actif ou inactif par défaut.
Lorsqu'un développeur est inactif, il peut toujours se connecter au portail des développeurs et créer des applications, mais aucune des clés API correspondantes ne fonctionnera. Les applications du développeur conservent leur état d'approbation, tout comme les clés API, même si elles ne sont pas valides tant que le développeur est inactif.
Pour activer ou désactiver un développeur, procédez comme suit :
- Accéder à la page "Développeurs".
- Cliquez sur la ligne correspondant au développeur que vous souhaitez activer ou désactiver pour ouvrir les détails associés.
- Dans la section "Détails", basculez le champ État sur Actif ou Inactif selon les besoins.
- Répétez cette procédure si le développeur figure dans plusieurs organisations.
Exporter des données de publication
Exportez les données de publication suivantes sous forme de fichier CSV (valeurs séparées par une virgule) :
- Détails du développeur
- Informations détaillées sur le développeur, l'application et l'API
Pour exporter des données de publication :
- Accéder à la page "Développeurs".
- Cliquez sur Exporter le fichier CSV….
- Dans le menu déroulant, sélectionnez Développeurs ou Développeurs, Applications et Produits.
Les données de publication sélectionnées sont téléchargées en tant que fichier CSV.
Supprimer un développeur
Pour supprimer un développeur, procédez comme suit :
- Accéder à la page "Développeurs".
- Placez le curseur sur la ligne correspondant au développeur que vous souhaitez supprimer pour afficher le menu des actions.
- Cliquez sur .
- Cliquez sur Supprimer pour confirmer la suppression.
Synchroniser les développeurs d'applications entre le portail et Edge
Si vous utilisez un portail des développeurs basé sur Drupal pour publier vos API, les modifications apportées aux développeurs d'applications avec Edge ne sont pas propagées au portail. Vous devez vous connecter au portail en tant qu'administrateur et le synchroniser avec Edge pour que ces modifications apparaissent sur le portail.
Pour synchroniser votre portail des développeurs avec les développeurs d'applications définis sur Edge, reportez-vous aux sections suivantes:
- Drupal 10: Synchroniser les développeurs avec Apigee Edge
- Drupal 7: Synchroniser les développeurs d'applications entre le portail et Edge
Regrouper les développeurs au sein d'entreprises
Avec la monétisation, une entreprise est un ensemble de développeurs gérés comme une entité unique. Une entreprise peut être n'importe quel regroupement approprié à votre organisation, comme une unité commerciale, une gamme de produits ou une division. Regrouper des développeurs au sein d'entreprises est utile lorsque vous devez associer plusieurs développeurs à une même entité juridique. Par exemple, vous devrez peut-être configurer différentes entreprises à des fins de facturation. Toutefois, les développeurs de votre organisation n'ont pas besoin d'être associés à une entreprise. Notez qu'un développeur est toujours une entité unique, identifiée de manière unique par l'élément "email". Si un développeur fait partie d'une entreprise, le nom de l'entreprise s'affiche sur la page "Développeurs".
Pour en savoir plus sur la gestion des entreprises et des développeurs à des fins de monétisation, consultez Gérer les entreprises et les développeurs.
Configurer les attributs de monétisation
Lorsque vous modifiez un développeur à l'aide de l'interface utilisateur, ou que vous en créez ou en modifiez un à l'aide de l'API, vous pouvez configurer les propriétés de monétisation définies dans le tableau suivant. Vous configurez initialement les propriétés de monétisation de l'organisation lorsque vous modifiez son profil.
Nom du champ | Nom de l'attribut personnalisé | Description |
---|---|---|
Adresse | MINT_DEVELOPER_ADDRESS |
Adresse du développeur, y compris les champs suivants: Adresse (lignes 1 et 2), Ville, État, Code postal et Pays. |
Profil de facturation | MINT_BILLING_PROFILE |
Cycle de facturation de votre organisation. Les valeurs valides sont les suivantes :
|
Type de facturation | MINT_BILLING_TYPE |
Modèle de paiement du développeur utilisé pour la facturation. Les valeurs possibles sont les suivantes :
Consultez Configurer les types de facturation prépayée et postpayée à l'aide de l'API. |
Catégorie | MINT_DEVELOPER_CATEGORY |
Catégorie de développeur à laquelle vous souhaitez ajouter le développeur. Une catégorie de développeurs regroupe des développeurs ou des entreprises présentant des caractéristiques similaires. Pour en savoir plus, consultez la section Gérer les catégories de développeurs. |
ID de l'entreprise | MINT_COMPANY_ID |
ID de l'entreprise, le cas échéant Pour en savoir plus, consultez la section Regrouper des développeurs par entreprise. |
Type de développeur | MINT_DEVELOPER_TYPE |
Cette propriété n'est pas utilisée par Apigee. Type de développeur. Les valeurs valides incluent |
Est courtier | MINT_IS_BROKER |
Indicateur indiquant si les revenus sont basés sur le résultat net. |
Nom légal | MINT_DEVELOPER_LEGAL_NAME |
Nom légal du développeur qui sera utilisé dans tous les rapports. Remarque: Cet attribut est obligatoire si le développeur n'est pas associé à une entreprise et souhaite s'abonner à un tarif publié. |
Autofacturation | MINT_HAS_SELF_BILLING |
Indicateur indiquant si les factures d'autofacturation sont activées. Si elle est activée (true ), la monétisation génère une facture d'autofacturation au lieu d'une déclaration de partage des revenus. Une facture auto-facturée est un document financier qui indique le montant dû au développeur. Il sert de facture au fournisseur d'API pour le compte du développeur. |
Numéro d'autorisation d'exonération fiscale | MINT_TAX_EXEMPT_AUTH_NO |
Numéro d'exonération fiscale gouvernementale, le cas échéant |
Taux de taxe | MINT_APPROX_TAX_RATE |
Taux de taxe approximatif pour le développeur. Spécifiez une valeur décimale avec un maximum de trois caractères avant la virgule et quatre caractères après la virgule. |
Gérer les développeurs à l'aide de l'API
Gérez les développeurs à l'aide des API de développeur.
Lorsque vous créez et mettez à jour un développeur à l'aide de l'API, vous pouvez configurer les attributs de monétisation décrits dans la section Configurer les attributs de monétisation, si nécessaire.