Vous consultez la documentation d'Apigee Edge.
Consultez la
documentation Apigee X. en savoir plus
Une organisation est le conteneur de niveau supérieur dans Apigee Edge. Elle contient tous les 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 :
- Par défaut, le nom de votre organisation se trouve dans l'URL utilisée pour appeler vos proxys d'API, comme décrit dans la section À propos des hôtes virtuels.
Exemple :
http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
- Le nom de votre organisation se trouve dans l'URL de l'UI de gestion Edge. Par exemple, l'URL suivante affiche les proxys d'API pour l'organisation
docs:
- Bien que vous ayez créé une seule organisation, vous pouvez appartenir à d'autres organisations en tant qu'utilisateur ou qu'administrateur disposant d'autorisations spécifiques. Dans l'interface utilisateur de gestion Edge, si vous appartenez à plusieurs organisations, vous pouvez basculer vers une autre organisation, comme décrit dans Basculer entre vos organisations.
- Lorsque vous effectuez des appels avec l'API de gestion en tant qu'utilisateur doté du rôle "Administrateur de l'organisation", l'organisation est une partie obligatoire du chemin d'accès dans la plupart des appels. Par exemple, la requête d'API de gestion cURL suivante renvoie une liste de tous les proxys d'API d'une organisation :
curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address
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.
Composants de l'organisation
Lorsque vous créez un compte Edge, Edge crée automatiquement une organisation pour vous. Une fois l'organisation créée, vous pouvez lui ajouter des utilisateurs, créer des proxys d'API et des produits d'API, et enregistrer des développeurs et des applications.
L'image suivante montre les principaux composants du modèle organisationnel Edge. 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 Edge.
Ce modèle n'affiche pas toutes les fonctionnalités d'Apigee Edge. Si vous utilisez la monétisation, le modèle disposera de composants supplémentaires. Pour en savoir plus, consultez Présentation de la monétisation. Pour en savoir plus sur la gestion des entreprises et des développeurs avec la monétisation, consultez Gérer les entreprises et les développeurs.
Noms des organisations
Le nom de l'organisation est:
- Organisation de l'évaluation:
username-eval - Organisation payante:définie par l'utilisateur au moment du provisionnement initial
Une fois une organisation créée, vous ne pouvez plus la renommer.
Le nom de l'organisation devient une partie de l'URL de vos proxys d'API et de l'URL lors de l'envoi d'une requête à l'API de gestion Edge. Par exemple, une URL type permettant d'accéder à un proxy d'API se présente sous la forme suivante :
http://org-name-env.apigee.net/v1/weather/forecastrss
où :
- org-name est le nom de votre organisation.
- env est l'environnement de déploiement du proxy d'API, qui est un environnement de test ou de production.
Exemple :
http://myorg-test.apigee.net/v1/weather/forecastrss
Composants de l'organisation
Le tableau suivant décrit plus en détail les composants du modèle organisationnel :
| Composant | Description |
|---|---|
|
Organisation |
Chaque compte Apigee est associé à une ou plusieurs organisations sur Apigee Edge. L'organisation contient une représentation de tous les composants, y compris les proxys d'API, les produits d'API, les packages d'API, les applications et les développeurs. 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. |
| Environnement | Contexte d'exécution pour les proxys d'API dans une organisation. Pour en savoir plus sur les environnements, consultez la section ci-dessous. |
|
Utilisateur |
Dans une organisation, où la personne qui crée le compte est automatiquement un administrateur, vous pouvez créer d'autres utilisateurs. Les utilisateurs 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, des utilisateurs surveillant les analyses et d'autres statistiques, et toute autre personne. 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. 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 Edge pour prendre en charge différentes communautés de développeurs. En interne cependant, les mêmes personnes créent tous les proxys d'API et tous les produits d'API, et sont donc membres de toutes vos organisations. Vous n'avez pas besoin de créer un compte Apigee, c'est-à-dire une organisation Apigee, pour être utilisateur. Un administrateur peut vous ajouter à une organisation existante. Tous les utilisateurs se connectent à Apigee Edge ici : https://enterprise.apigee.com. |
|
proxy d'API |
Les utilisateurs d'une organisation créent un ou plusieurs proxys d'API. Un proxy d'API définit le mappage d'un point de terminaison HTTP accessible au public avec un service de backend. Les proxys d'API peuvent également être configurés pour inclure la sécurité (par exemple OAuth), effectuer une transformation des messages (par exemple, XML en JSON), limiter le trafic aux services de backend et effectuer d'autres opérations intéressantes sur la requête et la réponse, et avec des appels de service. Edge collecte des données pour analyse sur les proxys d'API. |
|
Produit d'API |
Les utilisateurs d'une organisation créent un ou plusieurs produits d'API, chacun correspondant à un groupe de proxys d'API associés à un forfait. Ce forfait peut définir des limites d'accès sur les proxys d'API, assurer la sécurité, autoriser la surveillance et l'analyse, et proposer des fonctionnalités supplémentaires. Edge collecte des données à des fins d'analyse sur les produits d'API. |
|
Développeur |
Une organisation contient un ou plusieurs développeurs qui créent les applications utilisant les API (assemblés en 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 pour accéder à vos API. Les développeurs doivent être enregistrés dans votre organisation pour pouvoir enregistrer une application et recevoir une clé API afin 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'interface utilisateur de gestion Edge, créer un portail des développeurs pour les enregistrer via un site Web ou définir votre propre mécanisme d'enregistrement à l'aide de l'API de gestion Edge. Un développeur n'est pas obligé d'avoir un compte sur Edge et la plupart des développeurs n'ont pas besoin de savoir quoi que ce soit sur Edge. Si le développeur possède un compte sur Edge, c'est généralement en tant qu'utilisateur d'une autre organisation ou en tant qu'utilisateur des services d'API Edge. |
|
Application |
Les développeurs créent une ou plusieurs applications clientes qui utilisent vos API. Les développeurs doivent enregistrer leurs applications auprès de votre organisation. Une application dans Edge est une représentation de l'application réelle d'un développeur. Elle fournit à celui-ci une clé API à transmettre avec chaque requête adressée à vos API. Étant donné que toutes les applications sont enregistrées dans votre organisation, vous pouvez utiliser Edge pour surveiller et collecter des informations analytiques sur l'application et sur l'utilisation de vos API. |
|
Clé API/Jeton OAuth |
Selon le mécanisme d'autorisation que vous définissez pour vos API, l'application transmet une clé API avec chaque requête adressée à vos API. Si cette clé est valide, la requête est autorisée. Edge accepte différents types d'authentification, tels qu'une clé API simple, l'authentification OAuth à deux acteurs, l'authentification OAuth à trois acteurs, etc. En tant que fournisseur d'API, vous devez définir une méthode permettant aux développeurs d'enregistrer leurs applications. Pour cela, le développeur doit enregistrer son application afin que vous lui renvoyiez la clé requise pour accéder à vos API. Au moment de l'enregistrement de l'application, le développeur peut choisir d'accéder à un seul produit d'API ou à plusieurs. L'application réelle du développeur utilise la même clé pour accéder à tous les produits d'API associés à l'application (la représentation enregistrée de l'application du développeur dans Edge). 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 de l'application du développeur existe toujours dans votre organisation). Vous pouvez également définir une limite de temps sur une clé de sorte que le développeur doive l'actualiser après un délai spécifique. |
À propos des environnements
Un environnement est un contexte d'exécution d'exécution pour les proxys d'API d'une organisation. Vous devez déployer un proxy d'API dans un environnement avant de pouvoir y accéder. Vous pouvez déployer un proxy d'API dans un seul environnement ou dans plusieurs environnements.
Une organisation peut contenir plusieurs environnements. Par exemple, vous pouvez définir les environnements dev, test et prod dans une organisation.
L'organisation fournit un champ d'application pour certaines fonctionnalités Apigee. Par exemple, les données de mappage clé-valeur (KVM) peuvent être mises à disposition au niveau de l'organisation, ce qui signifie que les proxys d'API déployés dans n'importe quel environnement obtiendront les mêmes données de KVM. Certaines fonctionnalités, telles que la mise en cache, peuvent s'appliquer à l'organisation ou à un environnement spécifique au sein de l'organisation. Les données d'analyse Apigee sont partitionnées en fonction d'une combinaison d'organisation et d'environnement.
Vous trouverez ci-dessous les principales entités que vous gérez au sein d'une organisation, y compris celles définies de manière globale dans l'organisation, ainsi que celles définies spécifiquement pour un environnement :
