Enregistrer les développeurs d'applis

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

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 entièrement de l'identification de l'appelant de 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. Et 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 :

Recommandations pour la gestion des comptes de développeur sur des portails de développeurs

Apigee vous recommande de gérer les comptes des développeurs directement sur votre portail des développeurs.

Si vous utilisez le portail intégré, c'est le seul moyen de vous assurer que les comptes de développeur sur le portail intégré et Edge restent synchronisés.

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 à l'aide d'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 du 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 Classic Edge.

Périphérie

Pour accéder à la page Développeurs à l'aide de l'interface utilisateur Edge:

  1. Connectez-vous à apigee.com/edge.
  2. 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:

Classic Edge (cloud privé)

Pour accéder à la page Développeurs à l'aide de l'interface utilisateur Classic Edge:

  1. Connectez-vous à http://ms-ip:9000, où ms-ip correspond à l'adresse IP ou au nom DNS du nœud du serveur de gestion.
  2. Sélectionnez Publish > Developers (Publier > Développeurs) dans la barre de navigation en haut de l'écran.

La page "Développeurs" s'affiche.

Ajouter un développeur

Pour ajouter un développeur, procédez comme suit :

  1. Accéder à la page "Développeurs".
  2. Cliquez sur + Développeur.
  3. Saisissez les détails concernant le développeur, y compris ses prénom, nom, adresse e-mail et nom d'utilisateur.
  4. Cliquez sur Créer.

Afficher et modifier les informations du développeur

Affichez et modifiez les détails du développeur. Pour les organisations pour lesquelles la monétisation est activée, vous pouvez modifier les attributs personnalisés de monétisation définis dans la section Configurer les attributs de monétisation.

Pour afficher et modifier les détails d'un développeur, procédez comme suit :

  1. Accéder à la page "Développeurs".
  2. Cliquez sur la ligne du développeur que vous souhaitez afficher et modifier pour ouvrir ses informations détaillées.
  3. Les informations suivantes s'affichent dans la section "Détails". Si nécessaire, modifiez les informations du développeur.
    Detail 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 :
    • First Name (Prénom)
    • Nom
    • E-mail
    • Nom d'utilisateur
    Modifiez le contenu et appuyez sur Entrée pour confirmer la modification.
    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 les pages suivantes :
    Applications Applications enregistrées par le développeur. Consultez la section Enregistrer des applications.
  4. 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 Cloud public, Edge conserve les entités suivantes en cache pendant au moins 180 secondes après leur accès.

  • Jetons d'accès OAuth. Cela signifie qu'un jeton révoqué peut réussir pendant trois minutes au maximum, jusqu'à ce que la limite du 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

Vous pouvez ajouter jusqu'à 18 attributs personnalisés pour chaque développeur, y compris les attributs de monétisation décrits dans la section Configurer les attributs de la monétisation.

Pour gérer les attributs personnalisés:

  1. Accéder à la page "Développeurs".
  2. Cliquez sur la ligne du développeur pour lequel vous souhaitez gérer les attributs personnalisés afin d'ouvrir les informations le concernant.
  3. Cliquez sur + dans la section "Attributs personnalisés".
  4. Saisissez le nom et la valeur de l'attribut.
  5. Cliquez sur .
  6. 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 :

  1. Accéder à la page "Développeurs".
  2. Cliquez sur la ligne correspondant au développeur que vous souhaitez activer ou désactiver pour ouvrir les détails associés.
  3. Dans la section "Détails", basculez le champ État sur Actif ou Inactif selon les besoins.
  4. 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 :

  1. Accéder à la page "Développeurs".
  2. Cliquez sur Exporter le fichier CSV….
  3. 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 :

  1. Accéder à la page "Développeurs".
  2. Placez le curseur sur la ligne correspondant au développeur que vous souhaitez supprimer pour afficher le menu des actions.
  3. Cliquez sur .
  4. Cliquez sur Delete (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 utilisant Edge ne sont pas propagées sur le portail. Vous devez vous connecter au portail en tant qu'administrateur et synchroniser le portail 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 dans Edge, consultez les sections suivantes:

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 seule entité. Une entreprise peut correspondre à n'importe quel groupe pertinent pour votre organisation, tel qu'une unité commerciale, une gamme de produits ou une division. Regrouper les développeurs en entreprises est utile lorsque vous devez associer plusieurs développeurs sous une seule entité. Par exemple, vous devrez peut-être configurer plusieurs entreprises pour la 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 d'adresse e-mail. Si un développeur fait partie d'une entreprise, vous verrez son nom sur la page "Développeurs".

Pour en savoir plus sur la gestion des entreprises et des développeurs pour la 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 lorsque vous créez ou modifiez un développeur à l'aide de l'API, vous pouvez configurer les propriétés de monétisation définies dans le tableau suivant. Pour commencer, vous configurez les propriétés de monétisation de l'organisation lorsque vous modifiez son profil.

Nom du champ Nom d'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 :

  • PRORATED: la facturation est basée sur le nombre de jours pendant lesquels un produit API est utilisé au cours d'un mois calendaire.
  • CALENDAR_MONTH: la facturation est effectuée mensuellement.
Type de facturation MINT_BILLING_TYPE

Modèle de paiement du développeur utilisé pour la facturation. Les valeurs possibles sont les suivantes :

  • PREPAID: le développeur paie à l'avance l'utilisation d'un produit API. Les fonds sont déduits du solde du développeur lorsque le produit API est utilisé. Le développeur doit disposer d'un solde prépayé suffisant pour acheter le produit API.
  • POSTPAID: le développeur est facturé mensuellement (par facture) pour l'utilisation des produits d'API. Le développeur paie pour l'utilisation des produits d'API en fonction des conditions de paiement définies par le ou les forfaits inclus sur la facture.
  • LES DEUX: deux types de facturation sont acceptés. La valeur par défaut est PREPAID.

Consultez la section Configurer des types de facturation prépayée et post-payée à l'aide de l'API.

Catégorie MINT_DEVELOPER_CATEGORY Catégorie du développeur à laquelle vous souhaitez ajouter le développeur. Une catégorie de développeurs est un groupe de développeurs ou d'entreprises ayant des caractéristiques similaires. Pour en savoir plus, consultez 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 les développeurs en entreprises.
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: TRUSTED ou UNTRUSTED

Est un courtier MINT_IS_BROKER Indicateur spécifiant si les revenus sont basés sur des valeurs nettes.
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 regroupé avec une entreprise et souhaite s'abonner à un plan tarifaire publié.
Auto-facturation MINT_HAS_SELF_BILLING Indicateur spécifiant si les factures avec autofacturation sont activées. Si cette option est activée (true), la monétisation génère une facture d'auto-facturation au lieu d'un relevé de part des revenus. Une facture d'auto-facturation est un document financier qui détaille le montant dû au développeur. Il s'agit d'une facture adressée au fournisseur d'API au nom du développeur.
Numéro d'autorisation d'exonération fiscale MINT_TAX_EXEMPT_AUTH_NO Numéro d'exonération fiscale gouvernemental, 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 nombre maximal de 3 caractères avant la décimale et 4 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 modifiez un compte de 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.