Comprender las organizaciones

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 de Apigee. La organización de Apigee contiene todos tus proxies de API y recursos relacionados. Aunque en el resto de este tema se profundiza en las organizaciones, aquí tienes algunos puntos prácticos:

  • Una organización de Apigee es distinta de una organización de Google Cloud y depende de ella. Cuando creas una organización para Apigee X o Apigee hybrid, se asigna exactamente a un proyecto de Google Cloud, y la organización de Apigee y el proyecto de Google Cloud comparten el mismo nombre. No todos los proyectos de Google Cloud tienen una organización de Apigee asociada.
  • Cuando en la documentación de Apigee se 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 the Google Cloud console. Por ejemplo:
    https://console.cloud.google.com/apigee/overview?project=ORG_ID
  • Cuando invocas llamadas REST a la API de Apigee, el identificador de organización es una parte obligatoria de la ruta. Por ejemplo, la siguiente solicitud curl devuelve una lista de todos los proxies de API de una organización mediante la API Organizations:
    curl https://apigee.googleapis.com/v1/organizations/ORG_ID/apis
  • Aunque solo hayas creado una organización, puedes tener autorización en otras organizaciones como usuario o administrador con permisos específicos. En la consola de Cloud, puedes cambiar a otra organización, tal como se describe en el artículo Cambiar de organización.

Vídeo: consulta un breve vídeo para saber cómo las organizaciones admiten una arquitectura multiinquilino para la gestión de APIs.

Tipos de organizaciones

Hay dos tipos de organizaciones:

  • De pago: una organización permanente con total escalabilidad. También se conoce como organización de producción. Las organizaciones de pago son aquellas que se crean como parte de una suscripción o de un modelo de precios de Apigee de pago por uso.

  • Evaluación: una organización temporal de autoservicio para probar Apigee. A veces se denominan organizaciones de evaluación. Estas organizaciones tienen un límite de tiempo y no tienen la escalabilidad ni la flexibilidad de las organizaciones de producción.

Consulta también Comparar organizaciones de evaluación y de pago.

Duración de la organización de evaluación

Las organizaciones de evaluación tienen una vida útil limitada:

  1. Día 0: crea la organización de evaluación.
  2. Día 30: Google te envía una notificación por correo para advertirte de que la suscripción va a caducar.
  3. Día 60: Google elimina 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, así como entre los proyectos y las carpetas de Google Cloud.

Diagrama que muestra la organización de Apigee en una jerarquía de organizaciones de Google Cloud

Componentes de una organización

En la siguiente imagen se muestran los componentes principales del modelo de organización de Apigee. Este modelo define cómo se relacionan tus APIs, productos de API, aplicaciones y desarrolladores de aplicaciones en Apigee.

Diagrama jerárquico que muestra la organización como raíz de una implementación de Apigee.

Este modelo no muestra todas las funciones de Apigee, pero sí que la organización es la raíz de una implementación.

En la siguiente tabla se describen los componentes del modelo de organización 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 cuentas pueden definir o ser miembros de varias organizaciones que admitan diferentes comunidades de desarrolladores de aplicaciones.

Entornos y grupos de entornos

Un entorno es un entorno de software aislado dentro de una organización en el que se despliegan proxies de API. Puedes crear varios entornos en una organización.

Un grupo de entornos es un grupo de entornos con uno o varios nombres de host. El nombre de host forma parte de la URL que se usa para llamar a los proxies de API desplegados 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 proxy contiene las instrucciones y las políticas que Apigee ejecuta al procesar las solicitudes de los clientes y las respuestas del backend.

Producto de API

Una entidad para publicar APIs. Los productos de API se publican en el portal para desarrolladores para que los desarrolladores externos puedan consumirlos. Un producto de API presenta una interfaz para acceder a una o varias APIs publicadas. La interfaz (que se puede describir mediante una especificación de OpenAPI) puede incluir una combinación de una o varias solicitudes de API que gestionen uno o varios proxies de API.

Los usuarios de una organización crean productos de API. Al hacerlo, pueden adjuntar metadatos arbitrarios a cada producto de API. Un tipo de metadatos que se usa con frecuencia puede definir un plan de servicio, que puede especificar límites de acceso en las llamadas a la API, estipular requisitos de seguridad, permitir la monitorización y las analíticas, y proporcionar funciones adicionales.

Apigee recoge datos para las analíticas de productos de API.

Proveedor de APIs

La persona o entidad que crea y gestiona proxies y productos de API. Los desarrolladores de aplicaciones cliente acceden a estas APIs publicadas.

Desarrollador de aplicaciones

Una organización contiene uno o varios desarrolladores que crean las aplicaciones que consumen las APIs (publicadas como productos de API) definidas por tu 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, partners o desarrolladores externos que pueden pagar o no por acceder a tus APIs. Puedes considerar a los desarrolladores como clientes que usan tus APIs.

Los desarrolladores deben estar registrados en tu organización para poder registrar una aplicación y recibir una clave de API u otras credenciales de cliente que les permitan acceder a tus APIs. Como proveedor de APIs, tú decides cómo añadir, actualizar o eliminar desarrolladores de tu organización. Puedes añadirlos manualmente a través de la interfaz de usuario, crear un portal para desarrolladores para registrarlos a través de un sitio web o definir e implementar tu propio mecanismo de registro mediante la API de Apigee.

Aplicación de Apigee (o Aplicación)

Los desarrolladores de Apigee crean una o varias aplicaciones cliente que consumen tus APIs.

Los desarrolladores que creen aplicaciones cliente que llamen a APIs que requieran comprobaciones de credenciales (como claves de API o tokens de OAuth) deben crear primero un registro de aplicación en su organización. Un registro de aplicación proporciona al desarrollador la clave de API, un par de clave y secreto u otras credenciales que se deben usar cuando la aplicación cliente llama a tus APIs.

Como todas las aplicaciones están registradas en tu organización, puedes usar Apigee para monitorizar y recoger información analítica sobre la aplicación y sobre su uso de tus APIs.

Otros componentes de Apigee que no se muestran son las claves de API y los tokens de OAuth.

Apigee admite diferentes tipos de autenticación, como una clave de API simple, OAuth de dos pasos, OAuth de tres pasos y otros.

Si el proveedor de la API especifica la verificación de la clave de API como mecanismo de autorización, la aplicación cliente debe enviar una clave de API con cada solicitud a tus APIs. Si esa clave es válida, Apigee permite la solicitud. Si el proveedor de la API especifica la verificación de tokens de OAuth como mecanismo de autorización, la aplicación cliente debe obtener primero un token de OAuth y, a continuación, enviarlo con cada solicitud a tus APIs. Si el token es válido, Apigee permite la solicitud. Se pueden usar otros esquemas de autorización personalizados.

Como proveedor de APIs, debes definir un método para que los desarrolladores registren sus aplicaciones. Cada registro de aplicación tendrá una o varias claves o credenciales asociadas. Si permites que los desarrolladores registren sus propias aplicaciones a través de un portal para desarrolladores, estos podrán obtener la clave o la credencial necesarias para acceder a tus APIs mediante una experiencia de autoservicio cómoda.

En el momento de registrar la aplicación, los desarrolladores pueden elegir si quieren acceder a un solo producto de API o a varios. La aplicación de un desarrollador usa la misma clave o credencial para acceder a todos los productos de API asociados a la aplicación.

Puedes revocar la clave en cualquier momento para que la aplicación del desarrollador deje de tener acceso a tus APIs (aunque la representación registrada de la aplicación del desarrollador siga existiendo en tu organización). También puedes revocar a un desarrollador, en cuyo caso todas las credenciales de las aplicaciones registradas por ese desarrollador dejarán de funcionar. La revocación es reversible. Cuando Apigee crea la credencial de la aplicación, puedes especificar una fecha de vencimiento para que el desarrollador deba obtener una nueva clave o credencial después de un tiempo determinado.

Usuarios de Apigee

Los usuarios de Apigee forman el equipo de APIs de la organización, que puede incluir a administradores, creadores de proxies de API y productos de API, o usuarios que monitorizan analíticas y otras estadísticas. Los usuarios finales son las personas que usan las aplicaciones que crean los desarrolladores de Apigee. En la mayoría de los casos, en esta documentación se usa el término "usuario" para hacer referencia a un usuario de Apigee.

Los administradores pueden añadir usuarios a una organización.

Cada usuario puede tener un rol y unos privilegios de acceso diferentes. 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 privilegios para modificar otros usuarios.

Los usuarios pueden ser miembros de varias organizaciones. Por ejemplo, tu empresa puede definir varias organizaciones en Apigee para dar asistencia a diferentes comunidades de desarrolladores, aunque internamente las mismas personas creen todos los proxies de API y productos de API y, por lo tanto, sean miembros de todas tus organizaciones.

No es necesario crear una organización de Apigee para ser usuario. Un administrador puede añadirte a una organización.

En la Google Cloud consola, ve a la página de Apigee.

Ir a Apigee

Derechos y facturación

Tanto si la organización de pago usa el modelo de precios de suscripción como el de pago por uso, los elementos que se miden a efectos de facturación son los entornos, las llamadas a la API y las implementaciones de proxy.

Los planes de suscripción te permiten pagar por adelantado los derechos a cambio de descuentos significativos. Los planes de suscripción son más adecuados cuando el volumen de consumo es mayor, es decir, cuando hay un gran número de entornos, un volumen elevado de llamadas a la API o un gran número de proxies de API gestionados por Apigee. Con el modelo de pago por uso, solo pagas por los recursos que utilizas, pero no disfrutas de descuentos por volumen.

Derechos de suscripción

Organizaciones

Puedes habilitar Apigee en cualquier proyecto de Google Cloud. De esta forma, se crea una organización de Apigee para ese proyecto. Puedes crear tantas organizaciones como quieras. Del mismo modo que no se requiere ningún derecho ni se aplica ningún 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 los entornos se expresa en unidades. Para usar un derecho de unidad de entorno, debes seguir un proceso de dos pasos: primero, crea un entorno y, después, adjúntalo a una organización. Un entorno se contabiliza en tu derecho de unidades de entorno cuando se ha vinculado a una organización. Consulta los límites para ver el número máximo de entornos en una sola organización.

Puedes crear un entorno de Apigee en una o varias de las regiones de Google Cloud disponibles. Cada región en 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 la suma del número de unidades de entorno usadas en todas las organizaciones.

El número total de unidades de entorno que te corresponden es la suma de las unidades que se incluyen en tu nivel de suscripción y las unidades adicionales que has obtenido a través de los paquetes de entornos.

Google aplica el derecho a los entornos, por lo que no puedes superar el límite. Si intentas crear un entorno que supere el límite de tu derecho, recibirás un error. Puedes ampliar tu derecho comprando paquetes de entornos adicionales.

Llamadas a la API

Google contabiliza cada llamada a la API que procesa Apigee. El número total de llamadas a la API que tienes derecho a hacer es la suma del número que se incluye en tu nivel de suscripción y el número adicional que has obtenido mediante paquetes de llamadas.

Con un plan de suscripción, Google no aplica el límite de derechos a las llamadas a la API. Si superas el límite de llamadas a la API, Apigee seguirá atendiendo las llamadas a la API. Google te factura el uso que hagas por encima del derecho que ya tienes. Puedes ampliar tu derecho de llamadas a la API en cualquier momento comprando paquetes de llamadas adicionales.

Despliegues de proxy

Google cuenta cada proxy de API que despliegues. El total de tu derecho de implementación de proxy es la suma del derecho incluido en tu nivel de suscripción más el derecho adicional obtenido a través de los paquetes de implementación de proxy.

Con un plan de suscripción, Google no limita las implementaciones de proxy a tu derecho. Si implementas más proxies de los que te permite tu derecho, superando así tu derecho de implementación de proxies, Apigee seguirá permitiéndote implementar nuevos proxies y seguirá atendiendo las llamadas a la API. Google te factura el uso que hagas por encima del derecho actual. Puedes ampliar 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 pago por uso

Organizaciones

Puedes habilitar Apigee en cualquier proyecto de Google Cloud. De esta forma, se crea una organización de Apigee para ese proyecto. Puedes crear tantas organizaciones como quieras. Al igual que no se cobra por crear un proyecto de Google Cloud, con el modelo de precios de pago por uso, tampoco se cobra por crear una organización de Apigee.

Entornos

Puedes asociar varios entornos a tu organización de Apigee. Para usar un entorno, debes seguir un proceso de dos pasos: primero, crear el entorno y, después, asociarlo a una organización. Google te factura por los entornos que están vinculados a una organización.

Puedes crear hasta 85 entornos en una sola organización.

En los entornos multirregión, Google te factura por cada región en la que esté disponible el entorno. Puedes elegir cualquiera de las regiones de Google Cloud disponibles.

Llamadas a la API

Google contabiliza cada llamada a la API que procesa Apigee. Google te factura en función del número de llamadas a la API que procesen tus entornos de Apigee. No hay límite. Apigee se ajusta automáticamente y sigue atendiendo las llamadas a la API, incluso cuando aumenta la carga.

Despliegues de proxy

Google cuenta cada proxy de API que despliegues. Google te factura por el número de proxies de API desplegados en tus entornos de Apigee.

Para obtener más información, consulta Derechos de pago por uso.