Esta página se aplica a Apigee y Apigee Hybrid.
Consulta la documentación de
Apigee Edge.
Una organización es el contenedor de nivel superior en Apigee. Contiene todos los proxies de API y los recursos relacionados. Si bien en el resto de este tema se profundiza sobre las organizaciones, se presentan algunos puntos prácticos:
- Una vez creada, no puedes cambiar el nombre a una organización.
- El nombre de tu organización está en la URL de la IU de Apigee. Por ejemplo:
https://apigee.google.com/organizations/ORG_ID
- Cuando realizas llamadas con la API de Apigee, la organización es una parte obligatoria de la ruta en la mayoría de las llamadas. Por ejemplo, en la siguiente solicitud
curl, se muestra una lista de todos los proxies de API en una organización mediante la API de las organizaciones:curl https://apigee.googleapis.com/v1/organizations/YOUR_ORG_ID/apis
- Si bien puedes haber creado solo una organización, puedes pertenecer a otras organizaciones como usuario o administrador con permisos específicos. Puedes cambiar a una organización diferente, como se describe en Cambia entre las organizaciones.
- Una organización de Apigee no es lo mismo que una organización de Google Cloud. Cuando existe la posibilidad de ambigüedad, en este documento se especifica que la “organización” es una organización de Apigee.
Video: Mira un video breve si deseas obtener información sobre cómo las organizaciones admiten una arquitectura multiusuario para la administración de API.
Tipos de organización
Existen dos tipos de organizaciones:
Pago: Una organización permanente con escalabilidad completa. También se conoce como organización de producción. Las organizaciones pagadas incluyen aquellas creadas como parte de un modelo de precios de Apigee de pago por uso o de suscripción.
Evaluación: Una organización de autoservicio temporal para probar Apigee. También conocidas como organizaciones de evaluación, estas organizaciones tienen un tiempo limitado y carecen de la escalabilidad y flexibilidad de las organizaciones de producción.
Consulta también Compara organizaciones pagadas y de evaluación.
Vida útil de la organización de evaluación
Las organizaciones de evaluación tienen una vida útil limitada:
- Día 0: Crea la organización de evaluación.
- Día 30: Google te envía una advertencia por correo electrónico sobre el próximo vencimiento de la evaluación.
- Día 60: Google borra la organización eval.
Componentes de la organización
En la siguiente imagen, se muestran los componentes principales del modelo organizativo de Apigee. En este modelo, se define cómo tus API, productos de API y desarrolladores de apps están relacionados dentro de Apigee.
En este modelo, no se muestran todas las características de Apigee, pero tiene como objetivo mostrarte que la organización es la raíz de una implementación.
En la siguiente tabla, se describen los componentes del modelo organizativo con más detalle:
| Componente | Descripción |
|---|---|
| Organización |
Cada organización de Apigee pertenece exactamente a un proyecto de Google Cloud, y un proyecto puede contener como máximo una organización. Una organización contiene entornos, proxies de API, productos de API, paquetes de API, aplicaciones y usuarios. Los titulares de las cuentas no están limitados a una sola organización. Algunos titulares de las cuentas pueden definir o ser miembros de varias organizaciones que admiten diferentes comunidades de desarrolladores de apps. |
| Entornos y grupos de entornos | Un entorno es un entorno de software aislado, dentro de una organización, en el que implementas proxies de API. Puedes crear varios entornos en una organización. Un grupo de entornos es un grupo de entornos con uno o más nombres de host. El nombre de host es parte de la URL que se usa para llamar proxies de API implementados en cualquier entorno del grupo de entornos. |
|
proxy de API |
Un proxy de API es una interfaz entre las solicitudes entrantes y los servicios de backend. La entidad de proxy contiene las instrucciones y políticas que ejecuta Apigee a medida que procesa las solicitudes de los clientes y las respuestas del backend. |
|
Producto de API |
Una entidad para publicar las APIs. Los productos de API se publican en el portal para desarrolladores para su consumo por parte de desarrolladores externos. Un producto de API presenta una interfaz para acceder a una o más APIs publicadas. La interfaz (que se puede describir con una especificación de OpenAPI) puede incluir una combinación de una o más de las solicitudes a la API que controlan uno o más proxies de API. Los usuarios de una organización crean productos de API. Cuando lo hacen, pueden adjuntar metadatos arbitrarios a cada producto de API. Un tipo de metadatos de uso frecuente puede definir un plan de servicio, que puede especificar límites de acceso en las llamadas a la API, fomentar los requisitos de seguridad, permitir la supervisión y las estadísticas y proporcionar funciones adicionales. Apigee recopila datos para generar estadísticas sobre productos de API. |
|
Proveedor de API |
La persona o entidad que crea y administra productos y proxies de API. Los desarrolladores de apps cliente acceden a estas APIs publicadas. |
|
Desarrollador de aplicaciones |
Una organización contiene uno o más desarrolladores que compilan las apps que consumen las APIs (publicadas como productos de API) definidas por la organización. Los desarrolladores consumen APIs, pero no pueden crear APIs ni realizar ninguna otra acción en la organización. Los desarrolladores pueden ser internos de tu empresa, pueden ser socios o pueden ser desarrolladores externos que pueden pagar o no por el acceso a tus APIs. Puedes pensar en los desarrolladores como clientes que usan las APIs. Los desarrolladores deben estar registrados en su organización antes de que puedan registrar una aplicación y recibir una clave de API para acceder a sus API. Como proveedor de API, depende de ti determinar cómo agregar, actualizar o quitar desarrolladores de tu organización. Puedes agregarlas manualmente a través de la IU, crear un portal para desarrolladores y registrarlas a través de un sitio web, o definir tu propio mecanismo de registro mediante la API de Apigee. |
|
App de Apigee (o app) |
Los desarrolladores de Apigee crean una o más apps cliente que consumen las APIs. Los desarrolladores que crean aplicaciones cliente que llaman a las APIs que requieren verificaciones de credenciales (como claves de API o tokens de OAuth) primero deben crear un registro de apps en tu organización. El registro de la app proporciona al desarrollador la clave de API, un par de clave/secreto y otras credenciales que se deben usar cuando la aplicación cliente llama a tus APIs. Debido a que todas las apps están registradas en tu organización, puedes usar Apigee para supervisar y recopilar información analítica sobre la app y el uso de tus APIs. |
Las claves de API y los tokens de OAuth son los componentes adicionales de Apigee que no se muestran.
Apigee admite diferentes tipos de autenticación, como una clave de API simple, OAuth de dos segmentos, OAuth de tres segmentos y otros.
Si el proveedor de la API especifica la verificación de la clave de API como el mecanismo de autorización, la aplicación cliente debe pasar una clave de API con cada solicitud a tus APIs. Si esa clave es válida, Apigee permite la solicitud. De manera alternativa, si el proveedor de la API especifica la verificación del token de OAuth como el mecanismo de autorización, la aplicación cliente primero debe obtener un token de OAuth y, luego, pasarlo con cada solicitud a tus APIs. Si ese token es válido, Apigee permite la solicitud. Se pueden usar otros esquemas de autorización personalizados.
Como proveedor de API, debes definir una forma para que los desarrolladores registren sus aplicaciones. Cada registro de la app tendrá una o más claves o credenciales asociadas. Si permites que los desarrolladores registren sus propias aplicaciones a través de un portal para desarrolladores, estos pueden recuperar la clave o la credencial necesarias para acceder a tus APIs, a través de una experiencia de autoservicio conveniente.
Al momento del registro de la app, los desarrolladores pueden elegir acceder a un solo producto de API o a varios productos de API. La app de un desarrollador usa la misma clave o credencial para acceder a todos los productos de API asociados con la app.
En cualquier momento, puedes revocar la clave para que la app del desarrollador ya no tenga acceso a tus APIs (aunque la representación registrada de la app del desarrollador siga existiendo en tu organización). O bien, puedes definir un vencimiento de una clave para que el desarrollador deba actualizarla después de un período específico.
Usuarios de Apigee
Los usuarios de Apigee conforman el equipo de API de la organización, que puede incluir a personas como administradores, proxies de API y creadores de productos de API, o usuarios que supervisan análisis y otras estadísticas. Los usuarios finales son personas que usan las apps que compilan los desarrolladores de Apigee. En la mayoría de los casos, en esta documentación se usa el término “usuario” para referirse a un usuario de Apigee.
Los administradores pueden agregar usuarios a una organización.
Los distintos usuarios pueden tener diferentes roles y privilegios de acceso. Por ejemplo, puedes definir algunos usuarios como administradores de la organización y administradores de operaciones con privilegios para modificar la organización y sus componentes. Define otros usuarios con permisos para crear proxies de API y productos de API, pero sin los privilegios a fin de modificar otros usuarios.
Los usuarios pueden ser miembros de varias organizaciones. Por ejemplo, tu empresa podría definir varias organizaciones en Apigee para admitir diferentes comunidades de desarrolladores, aunque internamente, las mismas personas compilan todos los proxies y productos de APIs y, por lo tanto, son miembros de todas tus organizaciones.
No es necesario crear una organización de Apigee para ser usuario. Un administrador puede agregarlo a una organización existente.
Todos los usuarios acceden a Apigee aquí: IU de Apigee.
Autorizaciones
Los derechos de organización dependen de si la organización pagada usa un modelo de precios de suscripción o pago por uso.
Derechos de suscripción
Organizaciones: Los derechos de la organización se expresan en unidades. Cuando obtienes un derecho de unidad organizativa, puedes usarlo para habilitar una sola organización nueva en cualquier región que desees o extender una organización existente a una sola región nueva (mediante la expansión de nombres de dominio). Para los derechos, una organización en N regiones consume N unidades organizativas. Por ejemplo, si compras cuatro unidades organizativas nuevas, puedes hacer lo siguiente:
- expandir una organización existente a cuatro regiones nuevas
- o expandir cada una de las 2 organizaciones existentes a dos nuevas regiones
- o crear cuatro organizaciones nuevas, cada una disponible en una región
Tu autorización de unidad de organización total es el agregado del nivel de suscripción más los paquetes de organización pertinentes.
Entornos: Los derechos de entornos también se expresan en unidades. Son independientes de los derechos de la organización y se comportan de manera diferente. Hay un proceso de dos pasos para usar un derecho de unidad de entorno: primero, debes crear un entorno y, luego, adjuntarlo a una organización. Un entorno se considera en tu derecho de unidad de entorno cuando el entorno se adjunta a una organización.
El uso de unidades de entorno se calcula como la cantidad de entornos que se usan en todas las organizaciones y en cada región. En otras palabras, un entorno aprovisionado en dos regiones para una organización consumirá dos unidades de entorno de tu derecho.
Tu derecho de unidad total de entorno es el agregado del derecho proporcionado en tu nivel de suscripción más el derecho adicional obtenido a través de los paquetes de entorno o de organización. Si compras un paquete de organización, obtienes una unidad de organización y una cantidad determinada de unidades de entorno. Cualquier derecho de unidad de entorno que se agregue a través de un paquete de organización es independiente de cualquier organización que elijas crear o expandir. Los derechos de unidades de entorno que se agregan a través de los paquetes de organización solo se agregan al derecho de unidad de entorno total. Si deseas agregar más unidades de entorno sin comprar unidades de organización adicionales, puedes comprar un paquete de entorno.
Para obtener más información, consulta Derechos de suscripción.
Derechos de prepago
Organizaciones: Con el modelo de precio de prepago, los titulares de cuentas pueden acceder a una sola organización.
Entornos: Las autorizaciones de entornos son independientes de los derechos de organización. También se comportan de manera diferente a las autorizaciones de la organización, ya que hay un proceso de dos pasos para usarlas: primero, debes crear un entorno y, luego, adjuntarlo a una organización. Los entornos no se descuentan de tus límites de autorización hasta que se vinculen a una organización.
En otras palabras, la cantidad de entornos que se consideran en la autorización es la cantidad de entornos adjuntos a una organización.
El modelo de precios de prepago incluye una autorización de 85 entornos en todas las regiones.
Para obtener más información, consulta Derechos de prepago.