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. La organización de 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 organización de Apigee es distinta de una organización de Google Cloud y es su subsidiaria. Cuando creas una organización para Apigee X o Apigee Hybrid, esta se asigna a un solo proyecto de Google Cloud, y la organización de Apigee y el proyecto de Google Cloud comparten un nombre. No todos los proyectos de Google Cloud tienen una organización de Apigee asociada.
- Cuando la documentación de Apigee usa el término “organización”, se refiere específicamente a una organización de Apigee. En la documentación de Apigee, se usa la frase “organización de Google Cloud” para referirse a la alternativa.
- Una vez creada, no puedes cambiar el nombre de una organización de Apigee.
- El nombre de tu organización de Apigee se muestra como el proyecto en la URL de la sección de Apigee de la consola de Google Cloud.
Por ejemplo:
https://console.cloud.google.com/apigee/overview?project=ORG_ID
- Cuando invocas llamadas REST a la API de Apigee, el identificador de la organización es una parte obligatoria de la ruta. 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/ORG_ID/apis
- Si bien puedes haber creado solo una organización, puedes ser autorizado en otras organizaciones como usuario o administrador con permisos específicos. En la consola de Cloud, puedes cambiar a una organización diferente, como se describe en Cambia entre las organizaciones.
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. A veces, se las conoce 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.
- Día 60: Google borra la organización de evaluación.
Organizaciones de Apigee en la jerarquía de Google Cloud
En el siguiente diagrama, se muestra la relación entre las organizaciones y los entornos de Apigee, y los proyectos y las carpetas de Google Cloud.
Componentes dentro de una 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 tu organización antes de que puedan registrar una aplicación y recibir una clave de API o alguna otra credencial de cliente que permita el acceso a tus APIs. 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 e implementar 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). También puedes revocar a un desarrollador, en cuyo caso todas las credenciales de las apps registradas para ese desarrollador dejarán de funcionar. La revocación es reversible. En el momento en que Apigee crea la credencial de la app, puedes especificar un vencimiento para que el desarrollador deba obtener una clave o credencial nueva 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, y definir otros usuarios con permisos para crear proxies de API y productos de API, pero sin los privilegios para 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 en la consola de Cloud.
Derechos y facturación
Ya sea que la organización pagada use un modelo de precios de suscripción o pago por uso, los elementos que se miden para la facturación son los siguientes: entornos, llamadas a la API y despliegues de proxy.
Los planes de suscripción te permiten pagar por adelantado los derechos, a cambio de descuentos significativos. Los planes de suscripción tienen sentido en volúmenes de consumo más altos, donde hay una mayor cantidad de entornos, un gran volumen de llamadas a la API o una gran cantidad de proxies de API administrados por Apigee. En el modelo de pago por uso, solo pagas por los recursos que usas, pero no disfrutas de descuentos por volumen.
Derechos de suscripción
Organizaciones |
Puedes habilitar Apigee en cualquier proyecto de Google Cloud. De esta manera, se crea una organización de Apigee para ese proyecto. Puedes crear tantas organizaciones como quieras. Así como no se requiere ningún derecho ni cargo para crear un proyecto de Google Cloud, tampoco se requiere ningún derecho para crear una organización de Apigee. |
---|---|
Entornos |
El derecho de entornos se expresa en unidades. 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. Consulta Límites para conocer la cantidad máxima de entornos en una sola organización. Puedes crear un entorno de Apigee en una o más de las regiones de Google Cloud disponibles. Cada región a la que se asigna un entorno consume una unidad de entorno de tu derecho. Un entorno aprovisionado en una sola región consume una unidad de entorno de tu derecho. Un entorno aprovisionado en dos regiones consume dos unidades de entorno de tu derecho. El uso total de unidades de entorno es el agregado de la cantidad de unidades de entorno que se usan en todas las organizaciones. Tu derecho de unidad total de entorno es la suma del derecho proporcionado en tu nivel de suscripción más el derecho adicional obtenido a través de los paquetes de entorno. Google aplica el derecho para los entornos. No puedes exceder el límite de derechos. Si intentas crear un entorno que supere tu límite de derechos, recibirás un error. Puedes expandir tu derecho comprando paquetes de entorno adicionales. |
Llamadas a la API |
Google cuenta cada llamada a la API que procesa Apigee. Tu derecho total de llamadas a la API es la suma del derecho proporcionado en tu nivel de suscripción más el derecho adicional obtenido a través de los paquetes de llamadas. En un plan de suscripción, Google no aplica el límite de derechos para las llamadas a la API. Si superas tu derecho a llamadas a la API, Apigee seguirá publicando llamadas a la API. Google te factura por el uso que supere el derecho existente. Puedes expandir tu derecho de llamadas a la API en cualquier momento comprando paquetes de llamadas adicionales. |
Implementaciones de proxy |
Google cuenta cada proxy de API que implementes. Tu derecho total de implementación de proxy es la suma del derecho proporcionado en tu nivel de suscripción más el derecho adicional obtenido a través de los paquetes de implementación de proxy. En un plan de suscripción, Google no limita las implementaciones de proxy a tu derecho. Si implementas más proxies de los que permite tu derecho, lo que supera tu derecho de implementación de proxies, Apigee seguirá permitiéndote implementar proxies nuevos y seguirá publicando llamadas a la API. Google te factura el uso que supere el derecho existente. Puedes expandir tu derecho de Implementación de proxy comprando paquetes de llamadas adicionales. |
Para obtener más información, consulta Derechos de suscripción.
Derechos de prepago
Organizaciones |
Puedes habilitar Apigee en cualquier proyecto de Google Cloud. De esta manera, se crea una organización de Apigee para ese proyecto. Puedes crear tantas organizaciones como quieras. Así como no se cobra por crear un proyecto de Google Cloud, en el modelo de precios de pago por uso, no se cobra por crear una organización de Apigee. |
---|---|
Entornos |
Puedes adjuntar varios entornos a tu organización de Apigee. Hay un proceso de dos pasos para usar un entorno: primero, debes crearlo y, luego, adjuntarlo a una organización. Google te factura por los entornos que están adjuntos a una organización. Puedes crear hasta 85 entornos en una sola organización. En el caso de los entornos multirregionales, Google te factura por cada región en la que el entorno está disponible. Puedes elegir cualquiera de las regiones de Google Cloud disponibles. |
Llamadas a la API |
Google cuenta cada llamada a la API que procesa Apigee. Google te factura por la cantidad de llamadas a la API que procesan tus entornos de Apigee. No hay límites. Apigee se escala automáticamente y sigue publicando llamadas a la API, incluso a medida que aumenta la carga. |
Implementaciones de proxy |
Google cuenta cada proxy de API que implementes. Google te factura por la cantidad de proxies de API implementados en tus entornos de Apigee. |
Para obtener más información, consulta Derechos de prepago.