Cette page s'applique à Apigee et à Apigee hybrid.
Consultez la documentation d'Apigee Edge.
Une organisation est le conteneur de niveau supérieur dans Apigee. L'organisation Apigee contient tous vos proxys d'API et les ressources associées. Bien que le reste de cet article explique plus en détail les organisations, voici quelques points pratiques:
- Une organisation Apigee est distincte d'une organisation Google Cloud et en est une filiale. Lorsque vous créez une organisation pour Apigee X ou Apigee hybrid, elle est mappée sur un seul projet Google Cloud. L'organisation Apigee et le projet Google Cloud partagent un nom. Tous les projets Google Cloud ne sont pas associés à une organisation Apigee.
- Lorsque la documentation Apigee utilise le terme "organisation", il fait spécifiquement référence à une organisation Apigee. La documentation Apigee utilise l'expression "organisation Google Cloud" pour désigner l'alternative.
- Une fois créée, vous ne pouvez plus renommer une organisation Apigee.
- Le nom de votre organisation Apigee s'affiche comme projet dans l'URL de la section Apigee de la console Google Cloud.
Exemple :
https://console.cloud.google.com/apigee/overview?project=ORG_ID
- Lorsque vous appelez des appels REST à l'API Apigee, l'identifiant de l'organisation constitue une partie obligatoire du chemin d'accès. Par exemple, la requête
curl
suivante renvoie la liste de tous les proxys d'API d'une organisation à l'aide de l'API Organizations :curl https://apigee.googleapis.com/v1/organizations/ORG_ID/apis
- Bien que vous n'ayez créé qu'une seule organisation, vous pouvez être autorisé dans d'autres organisations en tant qu'utilisateur ou qu'administrateur disposant d'autorisations spécifiques. Dans la console cloud, vous pouvez passer à une autre organisation, comme décrit dans la section Passer d'une organisation à une autre.
Vidéo : Regardez une courte vidéo pour découvrir comment les organisations prennent en charge une architecture mutualisée pour la gestion des API.
Types d'organisations
Il existe deux types d'organisations :
Payante : organisation permanente avec évolutivité complète. Également appelée organisation de production. Les organisations payantes incluent celles créées dans le cadre d'un abonnement ou d'un modèle de paiement à l'usage d'Apigee.
Évaluation : organisation temporaire en libre-service permettant de tester Apigee. Ces organisations d'évaluation sont limitées dans le temps et ne disposent pas de l'évolutivité et de la flexibilité des organisations de production.
Consultez également la section Comparaison des organisations d'évaluation et payantes.
Durée de vie de l'organisation d'évaluation
Les organisations d'évaluation ont une durée de vie limitée:
- Jour 0:créez l'organisation d'évaluation.
- Jour 30:Google vous envoie une notification par e-mail vous informant de l'expiration à venir de l'organisation d'évaluation.
- Jour 60:Google supprime l'organisation d'évaluation.
Organisations Apigee dans la hiérarchie Google Cloud
Le diagramme suivant illustre la relation entre les organisations et les environnements Apigee, et les projets et dossiers Google Cloud.
Composants d'une organisation
L'image suivante montre les principaux composants du modèle organisationnel d'Apigee. Ce modèle définit la manière dont vos API, produits d'API, applications et développeurs d'applications sont tous liés dans Apigee.
Ce modèle n'affiche pas toutes les fonctionnalités d'Apigee, mais il est conçu pour vous montrer que l'organisation est la racine d'un déploiement.
Le tableau suivant décrit plus en détail les composants du modèle organisationnel :
Composant | Description |
---|---|
Organisation |
Chaque organisation Apigee appartient à un seul projet Google Cloud et un projet ne peut contenir qu'une seule organisation. Une organisation contient des environnements, des proxys d'API, des produits d'API, des packages d'API, des applications et des utilisateurs. Les titulaires de compte ne sont pas limités à une seule organisation. Certains titulaires de compte peuvent définir ou être membres de plusieurs organisations qui prennent en charge différentes communautés de développeurs d'applications. |
Environnements et groupes d'environnements | Un environnement est un environnement logiciel isolé, au sein d'une organisation, dans lequel vous déployez des proxys d'API. Vous pouvez créer plusieurs environnements au sein d'une organisation. Un groupe d'environnements est un groupe d'environnements avec un ou plusieurs noms d'hôte. Le nom d'hôte fait partie de l'URL utilisée pour appeler les proxys d'API déployés dans n'importe quel environnement du groupe d'environnements. |
proxy d'API |
Un proxy d'API est une interface entre les requêtes entrantes et les services de backend. L'entité de proxy contient les instructions et stratégies exécutées par Apigee lors du traitement des requêtes des clients et des réponses du backend. |
Produit d'API |
Entité permettant de publier des API. Les produits d'API sont publiés sur le portail des développeurs afin que les développeurs externes puissent les utiliser. Un produit d'API présente une interface permettant d'accéder à une ou plusieurs API publiées. L'interface (qui peut être décrite à l'aide d'une spécification OpenAPI) peut inclure une combinaison d'une ou plusieurs des requêtes API traitées par un ou plusieurs proxys d'API. Les utilisateurs d'une organisation créent des produits d'API. Ce faisant, ils peuvent associer des métadonnées arbitraires à chaque produit d'API. Un type de métadonnées couramment utilisé peut définir un forfait de service, qui peut lui-même spécifier des limites d'accès sur les appels d'API, définir des exigences de sécurité, autoriser la surveillance et l'analyse, et fournir des fonctionnalités supplémentaires. Apigee collecte des données pour analyse sur les produits d'API. |
Fournisseur d'API |
La personne ou l'entité qui crée et gère les proxys et les produits d'API. Les développeurs d'applications clientes accèdent à ces API publiées. |
Développeur d'applications |
Une organisation contient un ou plusieurs développeurs qui créent les applications utilisant les API (publiées sous forme de produits d'API) définies par votre organisation. Les développeurs utilisent des API, mais ne peuvent pas créer d'API ni effectuer d'autres actions dans l'organisation. Les développeurs peuvent être internes à votre entreprise, être des partenaires ou être des développeurs externes qui paient ou non pour accéder à vos API. Vous pouvez considérer les développeurs comme des clients qui utilisent vos API. Les développeurs doivent être enregistrés dans votre organisation pour pouvoir enregistrer une application et recevoir une clé API ou d'autres identifiants client permettant d'accéder à vos API. En tant que fournisseur d'API, il vous appartient de déterminer comment ajouter, mettre à jour ou supprimer des développeurs dans votre organisation. Vous pouvez les ajouter manuellement via l'UI, créer un portail des développeurs pour les enregistrer via un site Web ou définir et implémenter votre propre mécanisme d'enregistrement à l'aide de l'API Apigee. |
Application Apigee (ou application) |
Les développeurs Apigee créent une ou plusieurs applications clientes qui utilisent vos API. Les développeurs créant des applications clientes qui appellent des API nécessitant des vérifications d'identifiants (clés API ou jetons OAuth, par exemple) doivent d'abord créer un enregistrement de l'application auprès de votre organisation. Un enregistrement d'application fournit au développeur la clé API, une paire clé/secret ou d'autres identifiants à utiliser lorsque l'application cliente appelle vos API. Étant donné que toutes les applications sont enregistrées dans votre organisation, vous pouvez utiliser Apigee pour surveiller et collecter des informations analytiques sur l'application et sur l'utilisation de vos API. |
Les composants supplémentaires d'Apigee non affichés dans les clés API et les jetons OAuth.
Apigee est compatible avec différents types d'authentification, tels qu'une clé API simple, l'authentification OAuth à deux acteurs, l'autorisation OAUTH à trois acteurs, etc.
Si le fournisseur d'API spécifie comme mécanisme d'autorisation la validation de clé API, l'application cliente doit transmettre une clé API avec chaque requête adressée à vos API. Si cette clé est valide, Apigee autorise la requête. Sinon, si le fournisseur d'API spécifie comme mécanisme d'autorisation la validation de jeton OAuth, l'application cliente doit d'abord obtenir un jeton OAuth, puis le transmettre à chaque API. Si ce jeton est valide, Apigee autorise la requête. D'autres schémas d'autorisation personnalisés sont possibles.
En tant que fournisseur d'API, vous devez définir une méthode permettant aux développeurs d'enregistrer leurs applications. Chaque enregistrement d'application est associé à un ou plusieurs identifiants ou clés. Si vous autorisez les développeurs à enregistrer leurs propres applications via un portail des développeurs, ils peuvent récupérer la clé ou les identifiants requis pour accéder à vos API via une expérience pratique en libre-service.
Au moment de l'enregistrement de l'application, les développeurs peuvent choisir d'accéder à un seul produit d'API ou à plusieurs. L'application d'un développeur utilise la même clé/le même identifiant pour accéder à tous les produits d'API associés à l'application.
Vous pouvez révoquer la clé à tout moment pour que l'application du développeur n'ait plus accès à vos API (même si la représentation enregistrée pour l'application du développeur existe toujours dans votre organisation). Vous pouvez également révoquer un développeur, auquel cas toutes les identifiants des applications enregistrées pour ce développeur deviennent inutilisables. La révocation est réversible. Au moment où Apigee crée les identifiants de l'application, vous pouvez spécifier une date d'expiration afin que le développeur doive obtenir une nouvelle clé ou des nouveaux identifiants après un délai spécifique.
Utilisateurs Apigee
Les utilisateurs Apigee constituent l'équipe API de l'organisation, qui peut inclure des personnes telles que des administrateurs, des créateurs de produits d'API et de proxys d'API, ou encore des utilisateurs surveillant les analyses et d'autres statistiques. Les utilisateurs finaux sont les personnes qui utilisent les applications crées par les développeurs Apigee. Dans la plupart des cas, cette documentation utilise le terme "utilisateur" pour faire référence à un utilisateur Apigee.
Les administrateurs peuvent ajouter des utilisateurs à une organisation.
Les différents utilisateurs peuvent avoir des rôles et droits d'accès spécifiques. Par exemple, définissez certains utilisateurs en tant qu'administrateurs de l'organisation et administrateurs des opérations disposant des droits nécessaires pour modifier l'organisation et ses composants, et définissez d'autres utilisateurs dotés d'autorisations permettant de créer des proxys d'API et des produits d'API, mais qui ne disposent pas des droits nécessaires pour modifier les autres utilisateurs.
Les utilisateurs peuvent être membres de plusieurs organisations. Par exemple, votre entreprise peut définir plusieurs organisations sur Apigee pour prendre en charge différentes communautés de développeurs, même si, en interne, les mêmes personnes créent tous les proxys d'API et tous les produits d'API, et sont donc membres de tous vos organisations.
Vous n'avez pas besoin de créer une organisation Apigee pour être utilisateur. Un administrateur peut vous ajouter à une organisation existante.
Tous les utilisateurs se connectent à Apigee en accédant à l'interface utilisateur d'Apigee dans la console Cloud.
Droits d'accès et facturation
Que l'organisation payante utilise un modèle de tarification de type Abonnement ou paiement à l'usage, les éléments facturés sont les suivants : les environnements, les appels d'API et les déploiements de proxy.
Les abonnements vous permettent de prépayer des droits d'accès en échange de remises importantes. Les forfaits d'abonnement sont adaptés à des volumes de consommation plus élevés, par exemple lorsque vous avez un grand nombre d'environnements, un volume élevé d'appels d'API ou un grand nombre de proxys d'API gérés par Apigee. Avec le modèle de paiement à l'usage, vous ne payez que pour les ressources que vous utilisez, mais vous ne bénéficiez pas de remises sur le volume.
Droits d'abonnement
Organisations |
Vous pouvez activer Apigee dans n'importe quel projet Google Cloud. Une organisation Apigee est alors créée pour ce projet. Vous pouvez créer autant d'organisations que vous le souhaitez. Tout comme il n'est pas nécessaire de disposer d'un droit d'accès ni de payer pour créer un projet Google Cloud, il n'est pas nécessaire de disposer d'un droit d'accès pour créer une organisation Apigee. |
---|---|
Environnements |
Les droits d'environnement sont exprimés en unités. Pour utiliser un droit d'unité d'environnement, vous devez suivre ce processus en deux étapes: vous devez d'abord créer un environnement, puis vous l'associez à une organisation. Un environnement est comptabilisé dans vos droits d'unité d'environnement lorsqu'il a été associé à une organisation. Consultez la section Limites pour connaître le nombre maximal d'environnements dans une même organisation. Vous pouvez choisir de créer un environnement Apigee dans une ou plusieurs des régions Google Cloud disponibles. Chaque région dans laquelle un environnement est mappé consomme une unité d'environnement de votre droit. Un environnement provisionné dans une seule région consomme une unité d'environnement de votre droit. Un environnement provisionné dans deux régions consomme deux unités d'environnement de votre droit. L'utilisation totale des unités d'environnement correspond à la somme du nombre d'unités d'environnement utilisées dans toutes les organisations. Votre nombre total de droits d'unités d'environnement correspond à la somme du droit fourni dans votre niveau d'abonnement et des droits supplémentaires obtenus via les packs d'environnement. Google applique le droit d'accès aux environnements. Vous ne pouvez pas dépasser la limite de droits d'accès. Si vous essayez de créer un environnement qui dépasse la limite de vos droits d'accès, une erreur s'affiche. Vous pouvez augmenter votre droit d'accès en achetant des packs d'environnement supplémentaires. |
Appels d'API |
Google comptabilise chaque appel d'API traité par Apigee. Votre nombre total de droits d'appel d'API correspond à la somme du droit fourni dans votre niveau d'abonnement et des droits supplémentaires obtenus via les packs d'appels. Avec un forfait, Google n'applique pas la limite d'accès aux appels d'API. Si vous dépassez votre droit d'appel d'API, Apigee continuera de diffuser des appels d'API. Google vous facture l'utilisation au-delà de l'éligibilité existante. Vous pouvez augmenter votre quota d'appels d'API à tout moment en achetant des packs d'appels supplémentaires. |
Déploiements de proxy |
Google comptabilise chaque proxy d'API que vous déployez. Votre droit d'accès total au déploiement de proxy correspond à la somme du droit fourni dans votre niveau d'abonnement et des droits supplémentaires obtenus via les packs de déploiement de proxy. Avec un forfait d'abonnement, Google ne limite pas les déploiements de proxy à vos droits d'accès. Si vous déployez plus de proxys que votre droit d'accès ne le permet, dépassant ainsi votre droit de déploiement de proxy, Apigee continue de vous autoriser à déployer de nouveaux proxys et de traiter les appels d'API. Google vous facture l'utilisation au-delà de l'éligibilité existante. Vous pouvez étendre votre droit de déploiement de proxy en achetant des packs d'appels supplémentaires. |
Pour en savoir plus, consultez les droits d'abonnement.
Droits de paiement à l'usage
Organisations |
Vous pouvez activer Apigee dans n'importe quel projet Google Cloud. Une organisation Apigee est alors créée pour ce projet. Vous pouvez créer autant d'organisations que vous le souhaitez. Tout comme la création d'un projet Google Cloud est gratuite, la création d'une organisation Apigee est également gratuite avec le modèle de tarification "Pay-as-you-go" (paiement à l'utilisation). |
---|---|
Environnements |
Vous pouvez associer plusieurs environnements à votre organisation Apigee. Pour utiliser un environnement, vous devez suivre ce processus en deux étapes: vous devez d'abord créer l'environnement, puis l'associer à une organisation. Google vous facture les environnements associés à une organisation. Vous pouvez créer jusqu'à 85 environnements dans une même organisation. Pour les environnements multirégionaux, Google vous facture chaque région dans laquelle l'environnement est disponible. Vous pouvez choisir n'importe quelle région Google Cloud disponible. |
Appels d'API |
Google comptabilise chaque appel d'API traité par Apigee. Google vous facture le nombre d'appels d'API traités par vos environnements Apigee. et il n'y a potentiellement aucune limite. Apigee s'adapte automatiquement et continue de traiter les appels d'API, même lorsque la charge augmente. |
Déploiements de proxy |
Google comptabilise chaque proxy d'API que vous déployez. Google vous facture le nombre de proxys d'API déployés dans vos environnements Apigee. |
Pour en savoir plus, consultez les droits de paiement à l'usage.