Enregistrer des développeurs d'applications

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d' Apigee Edge.

Enregistrez et gérez vos développeurs d'applications comme décrit dans les sections suivantes. (l'enregistrement des applications est un processus distinct, comme décrit dans la page Contrôler l'accès à vos API en enregistrant des applications).

Présentation

Apigee 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 Apigee 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 utilisateur sur les portails des développeurs

Apigee vous recommande de gérer les comptes utilisateur 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 utilisateur du portail intégré et Apigee restent synchronisés.

Si vous utilisez le portail des développeurs basé sur Drupal, la gestion des comptes utilisateur directement sur le portail des développeurs 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 Apigee, 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 à Apigee.

Si vous décidez de gérer des comptes utilisateur basés sur Drupal à l'aide d'Apigee, vous devez synchroniser les développeurs d'applications entre le portail et Apigee.

Explorer la page Développeurs

Accédez à la page "Développeurs" et explorez-la à l'aide de l'interface utilisateur d'Apigee.

Pour accéder à la page Distribution > Développeurs :

Accéder à "Développeurs"

La page Développeurs vous permet d'effectuer les opérations suivantes :

Ajouter un développeur

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

  1. Accéder à la page "Développeurs".
  2. Cliquez sur + Créer.
  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 Ajouter.

Consultez également la page Gérer des comptes utilisateur.

Afficher et modifier les informations du développeur

Affichez et modifiez les détails du développeur.

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. Cliquez sur  Modifier pour modifier les informations du développeur, si nécessaire.
    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.
    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 la section Gérer les attributs personnalisés d'un développeur.
    Applications Applications enregistrées par le développeur. Consultez la page Contrôler l'accès à vos API en enregistrant des applications.
  4. Le champ État vous permet d'activer ou de désactiver le développeur.
    Pour en savoir plus, consultez la section Activer et désactiver un développeur.

Apigee 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 que l'élément ExpiresIn de la règle OAuth v2 ne pourra pas faire expirer un jeton d'accès en moins de 180 secondes.
  • 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.

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 Modifier.
  4. Cliquez sur + Ajouter un attribut dans la section Attributs personnalisés.
  5. Saisissez le nom et la valeur de l'attribut.
  6. Cliquez sur Enregistrer.
  7. Pour supprimer un attribut personnalisé, cliquez sur Modifier, puis sur Supprimer, puis sur Enregistrer.

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. Cliquez sur Modifier.
  4. Dans la section "Détails", définissez le champ État sur Actif ou Inactif selon les besoins.
  5. Cliquez sur Enregistrer.
  6. Répétez cette procédure si le développeur figure dans plusieurs organisations.

Exporter des données de publication

Cette section explique comment exporter des données de publication pour les développeurs, les applications ou les produits d'API sous la forme d'un fichier CSV (valeurs séparées par une virgule) ou d'un fichier JSON.

Prérequis :

  • Bucket Cloud Storage
  • Accès en lecture aux données que vous exportez
  • Accès en lecture et en écriture au bucket Cloud Storage

Pour en savoir plus sur les buckets, consultez les ressources suivantes :

Pour exporter des données de publication :

  1. Créez le bucket Cloud Storage ou obtenez le nom d'un bucket existant.
  2. Accédez à l'une des pages suivantes :
  3. Cliquez sur Exporter.
  4. La boîte de dialogue Enregistrer la table sous s'affiche. Saisissez le nom du bucket Cloud Storage et spécifiez le format d'exportation : JSON ou CSV.
  5. Cliquez sur Enregistrer. Une opération de longue durée (LRO) commence. L'état de l'opération de longue durée s'affiche dans l'icône Notification .
  6. Une fois l'exportation terminée, cliquez sur Télécharger dans la notification. La page du bucket Cloud Storage du fichier s'ouvre.
  7. Cliquez sur Télécharger. Le fichier est téléchargé sur votre ordinateur local.
Remarques sur les données exportées :
  • La structure des données exportées suit exactement les définitions de proto afin que la documentation du proto puisse être utilisée comme référence pour les structures de données exportées. Consultez :
  • Contrairement à l'interface utilisateur classique d'Apigee, chaque ressource dispose d'un bouton d'exportation indépendant et dédié.
  • Les exportations au format CSV ne répertorient aucun champ répété ou imbriqué du proto, car il ne peut pas être correctement représenté dans une structure de données de table. Pour obtenir ces informations, vous devez utiliser l'exportation JSON.
  • Les fichiers exportés sont nommés ExportFinal_{hash}.

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 du développeur que vous souhaitez supprimer.
  3. Cliquez sur Plus, puis sur Supprimer.
  4. Cliquez sur Supprimer pour confirmer la suppression.

Synchroniser les développeurs d'applications entre le portail et Apigee

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 Apigee ne sont pas propagées au portail. Vous devez vous connecter au portail en tant qu'administrateur et le synchroniser avec Apigee pour que ces modifications apparaissent sur le portail.

Pour synchroniser votre portail des développeurs avec les développeurs d'applications définis sur Apigee, reportez-vous à la section suivante :

Drupal 10 : Synchroniser les développeurs avec Apigee

Gérer les développeurs à l'aide de l'API

Gérez les développeurs à l'aide des API de développeur.