Glosario

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Los siguientes conceptos son ideas comunes que tienen un significado único en Apigee.

A

Ruta de acceso y recursos base de la API: Una API está formada por una ruta base y un conjunto de recursos (también conocidos como rutas de recursos). Para cada API, defines una única URL raíz (también llamada ruta base y varias rutas de recursos). Puedes pensar en una API como un conjunto de URI, en los que todos comparten una ruta de acceso base. Para facilitar la administración de tus API, Apigee aumenta estos URI sin procesar con nombres y descripciones visibles.
Consumidor de API: Sinónimo de desarrollador de apps, que usa las API que crea un proveedor de API.
Desarrollador de API: Un ingeniero de software de una organización proveedora de API que compila API. Los desarrolladores de apps (consumidores de API) usan esas API para compilar aplicaciones.
Producto de API: Una colección de recursos de API (URI) combinados con un plan de servicio que se presenta a los desarrolladores como un paquete. El producto de API también puede incluir algunos metadatos específicos de tu empresa para la supervisión o el análisis. Se pueden monetizar uno o más recursos si los incluyes en un producto de API, que luego se puede agrupar a un paquete de API para monetización.
Proveedor de API: Un proveedor de API compila API (mediante Apigee) para que usen los consumidores de API (desarrolladores de apps).
Proxy de API: Un proxy que actúa como fachada para tu API existente. En lugar de llamar a tu API existente, los desarrolladores comienzan a llamar a la API nueva que genera Apigee. Esta fachada desacopla tu interfaz pública de la API de backend, lo que protege a los desarrolladores de los cambios de backend, y te permite innovar en el perímetro sin afectar a tus equipos de desarrollo interno. A medida que realizas cambios en el backend, los desarrolladores siguen llamando a la misma API sin interrupciones. En situaciones más avanzadas, Apigee te permite exponer varias interfaces para la misma API, lo que te permite personalizar la firma de una API para satisfacer las necesidades de diversos nichos de desarrolladores de manera simultánea.
API de Apigee: Los extremos que puedes usar para configurar entornos, organizaciones, proxies de API y otros servicios híbridos.
Desarrollador de apps: En Edge, los desarrolladores de apps registran sus apps con un proveedor de API, de modo que los desarrolladores de aplicaciones obtengan las claves de API que necesitan para llamar a los proxies de API del proveedor.
apps: Tus desarrolladores usan aplicaciones para acceder a los recursos en tus productos de API. Cuando creas una aplicación, seleccionas el producto de API que deseas incluir y Apigee genera una clave. Cada app tiene una clave única que proporciona acceso a varios productos de API. Las apps te permiten controlar quiénes pueden acceder a tus recursos. Puedes controlar quién tiene acceso a tus productos de API mediante la revocación y actualización de la clave de una app. Además, puedes controlar el acceso a los paquetes de recursos si revocas o borras el acceso a los productos de una app.

B

Detalles del saldo: En el caso de un desarrollador prepago, el saldo en la cuenta del desarrollador.

C

Cassandra

(Solo para Apigee Hybrid ) El repositorio de datos del entorno de ejecución que almacena configuraciones de aplicaciones, contadores de cuotas distribuidas, claves de API y tokens de OAuth para aplicaciones que se ejecutan en la puerta de enlace.

Este es un StatefulSet de uso intensivo de recursos y debe estar en un nodo trabajador separado de Message Processor.

Para obtener más información, consulta Acerca del plano de entorno de ejecución.

infraestructura de administración central (o plano)

Consulta plano de administración.

imagen de contenedor [en contenedores]

Ve la imagen

plano de control

Consulta plano de administración.

D

implementar

En Apigee, debes implementar un proxy de API en un entorno para que los clientes de aplicaciones puedan acceder a él en Internet, ya sea de forma pública o privada, según la configuración de tu red.

desarrollador

Un desarrollador hace referencia a un rol que un usuario de Apigee podría realizar. Existen dos tipos de desarrolladores en Apigee:

Desarrolladores del proxy de API: crean los proxies de API y aplican las políticas.
Desarrolladores de aplicaciones: crean aplicaciones que consumen proxies de API.

plan de tarifas de categorías de desarrolladores

Un plan de tarifas que se aplica a todos los desarrolladores de una categoría específica y que está disponible para que lo compren todos los desarrolladores de esa categoría.

plan de tarifa de desarrolladores

Un plan de tarifas que se aplica a un desarrollador específico y que solo está disponible para que lo compre ese desarrollador.

E

entorno: Un entorno de Apigee es un entorno de software aislado, dentro de una organización y en el que implementas proxies de API. El entorno puede escalar para satisfacer las demandas de los proxies implementados allí. Puedes crear varios entornos en una organización.
grupo de entornos: Un grupo de entornos es un grupo de entornos de Apigee 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.
límite explícito: Consulta el límite personalizado.

G

GCR: Google Container Repository
GKE: Google Kubernetes Engine Un entorno administrado por Google para la producción con el que se implementan aplicaciones en contenedores en Kubernetes. GKE Te permite ejecutar Kubernetes sin demoras, ya que elimina por completo la necesidad de instalar, administrar y operar tus propios clústeres de Kubernetes.

I

repositorio de imágenes
límite implícito: Un límite (como un límite de saldo prepagado de un desarrollador) que establece la monetización.
Controlador de Ingress/Ingress: Una app alojada en contenedores que enruta el tráfico desde fuera del clúster hacia servicios dentro del clúster.

K

KMS: Servicio de administración de claves Almacena, mantiene y presenta claves y tokens de OAuth para encriptar y desencriptar tráfico. Apigee KMS administra las claves de las aplicaciones, los desarrolladores y los productos de API.
KVM: Mapa de plan clave-valor Una colección personalizada de pares de strings de clave-valor que están encriptados o no encriptados. Para obtener más información, consulta Usa mapas de clave-valor.
Máquina de administración de Kubernetes: La máquina local que usas para ejecutar comandos en tu clúster de Kubernetes Esta máquina suele ser una computadora de escritorio que tiene acceso a tus VM de Kubernetes.

M

plano de administración

Los servicios centrales alojados en Google que se comunican con el plano de entorno de ejecución a través de cuentas de servicio.

MART

La API para los datos del entorno de ejecución interactúa con el almacén de datos del entorno de ejecución local (Cassandra). Sirve como proveedor de API para la API de Apigee pública a fin de acceder y administrar los datos del entorno de ejecución.

MART es una aplicación sin estado, al igual que los procesadores de mensajes. Es una app alojada en contenedores en Kubernetes.

Para obtener más información, consulta Acerca del plano de entorno de ejecución.

nodo principal

Un término de Kubernetes para un nodo que incluye apiserver, cloud-controller-manager (CCM), scheduler y kube-controller-manager.

Message Processor

(Solo para Apigee Hybrid ) Message Processor evalúa una solicitud entrante, ejecuta cualquier política de Apigee y llama a los sistemas de backend y a otros sistemas para recuperar datos. Una vez que se reciben esas respuestas, el procesador de mensajes formatea una respuesta y se la muestra al cliente.

El MP es una implementación de Kubernetes. Se configura para un solo entorno Apigee, que apunta a un subdirectorio con permisos dentro del sistema de archivos compartido al que el Sincronizador proporciona datos.

Un MP requiere muchos recursos y debe estar en un nodo trabajador separado de Cassandra.

Para obtener más información, consulta Acerca del plano de entorno de ejecución.

Monetización

Componente de los servicios de Apigee que ofrece una manera fácil y flexible de monetizar productos de API.

importe mensual usado

Uso total de un desarrollador para un mes determinado, que incluye la tarifa de configuración + tarifa de transacción + la tarifa recurrente.

Pagos mensuales

Los pagos recurrentes que realiza el desarrollador en función de los planes que se compran. Los planes de tarifas pueden tener una tarifa recurrente que se le cobra a un desarrollador cada mes, sin importar el uso.

N

espacio de nombres: Clústeres virtuales que se usan para dividir los recursos del clúster. Los espacios de nombres son para clústeres más grandes con muchos usuarios. Por lo general, los clústeres más pequeños con decenas de usuarios no necesitan espacios de nombres.

O

ajuste abierto

Un ajuste que aún no se aplicó en los documentos de facturación publicados.

mes de facturación abierto

Un mes calendario completo en el que no se publicaron documentos de facturación finales.

kubernetes de código abierto

La implementación de referencia de Kubernetes. Consulta Kubernetes. El entorno de ejecución de Apigee Hybrid se ejecuta en Kubernetes de código abierto y versiones basadas en código abierto de Kubernetes cumplen con la convención CNCF.

organización

Un contenedor para todas las entidades en una cuenta de Apigee, incluidos los proxies de API, los productos de API, los paquetes de API, las aplicaciones y los desarrolladores. En este documento, se usan los términos organización de Apigee u organización híbrida habilitada de forma intercambiable.

Para instalar y usar Apigee o Apigee Hybrid, debes tener una organización de Apigee que esté vinculada a un proyecto de Google Cloud. Esto se hace cuando creas la organización en un proceso conocido como aprovisionamiento.

Una organización de Apigee no es lo mismo que una organización de Google Cloud. En los casos en que exista la posibilidad de ambigüedad, en este documento, se debe especificar que la organización es una organización de Apigee.

Para obtener más información, consulta Organization types.

P

Pod: Un pod es el bloque de compilación básico de Kubernetes: la unidad más pequeña y más simple del modelo de objetos de Kubernetes que creas o implementas. Un pod representa un proceso en ejecución en tu clúster.
saldo prepagado: Una cantidad de dinero disponible para que un desarrollador prepago pague de forma anticipada por los paquetes de API.
desarrollador prepagado: Un desarrollador que paga por adelantado el uso de un producto de API. Los fondos se deducen del saldo del desarrollador prepago cuando se usa el producto de API. El desarrollador debe mantener un saldo prepago suficiente para comprar el producto de API. El proveedor de la API asigna el estado de prepago o pospago, a los desarrolladores.
Política: Un paso de procesamiento que se ejecuta como una unidad de lógica atómica y reutilizable dentro de un flujo de API. Las políticas comunes incluyen el enrutamiento de solicitudes al extremo adecuado, la transformación de un formato de mensaje, la aplicación del control de acceso, la llamada a servicios remotos para obtener información adicional, el enmascaramiento de datos sensibles ante los usuarios externos, el examen del contenido de los mensajes para detectar amenazas, el almacenamiento en caché de las respuestas comunes para mejorar el rendimiento y mucho más. Las políticas se pueden ejecutar condicionalmente según el contenido o el contexto de una solicitud o mensaje de respuesta. Por ejemplo, una política de transformación se puede ejecutar para personalizar un formato de respuesta si el mensaje de solicitud se envió desde un smartphone.
desarrollador pospago: Un desarrollador que recibe facturas mensuales por el uso de productos de API. El desarrollador paga por el uso de productos de API según las condiciones de pago establecidas en los planes de tarifas. A los desarrolladores se les asigna el estado de pospago o de prepago por parte del proveedor de la API.
proxy: También, proxy de API Un proxy de API es una capa de abstracción que sirve de fachada para las API del servicio de backend y proporciona funciones de valor agregado, como seguridad, límite de frecuencia, cuotas, estadísticas y mucho más.
extremo de proxy: Un extremo de proxy define la forma en que tu proxy de API interactúa con las aplicaciones cliente. Configuras el extremo de proxy con una ruta base que forma parte de la URL a la que responde el proxy de API. La URL tiene el formato https://hostname/basepath/pathsuffixes. Consulta Crea un proxy de API.

R

plan de tarifa

Una especificación de las tarifas, otros cargos y el porcentaje de ingresos por el uso de los productos de API que se ofrecen en un paquete de API monetizado

controlador de replicación

Vuelve a programar los pods y maneja se reparación automática.

recurso, ruta de recursos

Un concepto de RESTful. Una ruta de acceso a un recurso es un identificador de recursos uniforme (URI) que identifica la ruta de red a un recurso determinado.

revisión

Un paquete numerado de configuración y políticas controlado por versiones incluidas en un proxy de API. Este término se distingue de versión, que es la interfaz de la API orientada al desarrollador. Consulta la “versión” a continuación.

plano de entorno de ejecución

Los servicios híbridos de Apigee que administras en tu clúster de Kubernetes existen dentro del plano de entorno de ejecución. Estos servicios se comunican a través de cuentas de servicio con el plano de administración.

Incluye MART, Synchronizer, Message Processors, Cassandra y otros componentes.

Para obtener más información, consulta Acerca del plano de entorno de ejecución.

instancia del entorno de ejecución

Apigee se puede configurar con varias instancias del entorno de ejecución, una por región geográfica. Se pueden conectar uno o más entornos a una instancia del entorno de ejecución, lo que proporciona alta disponibilidad para proxies de API en todas las regiones.

S

servicio

Un término general para las apps en contenedores que se ejecutan en tu clúster de Kubernetes dentro del plano del entorno de ejecución. Estos servicios incluyen MART, Synchronizer, procesadores de mensajes y Cassandra.

Para obtener más información, consulta Acerca del plano de entorno de ejecución.

nodo con estado

Un nodo de clúster que requiere almacenamiento continuo para mantener el estado. Consulta Configura grupos de nodos dedicados.

nodo sin estado

Un nodo de clúster que no requiere almacenamiento continuo. Consulta Configura grupos de nodos dedicados.

Sincronizador

Un servicio de plano de entorno de ejecución que sondea el plano de administración para la configuración de implementación y los eventos de cada entorno. Descarga los metadatos necesarios sobre los proxies implementados, los archivos de configuración del proxy y mucho más en el plano del entorno de ejecución.

Synchronizer almacena su información en un sistema de archivos compartidos que lee el procesador de mensajes. Esto se ejecutará como una aplicación DaemonSet; no tiene tráfico de API de entorno de ejecución y puede sincronizar datos para varios entornos desde un solo proceso o pod de Kubernetes.

Para obtener más información, consulta Acerca del plano de entorno de ejecución.

T

extremo de destino: Un extremo de destino define la forma en que tu proxy de API interactúa con tus servicios de backend. Puedes configurar el extremo de destino para reenviar solicitudes al servicio de backend adecuado, incluida la definición de la configuración de seguridad, el protocolo HTTP o HTTPS, y otra información de conexión. Consulta Cambia el extremo de destino.
agrega dinero: Acción realizada por un desarrollador prepago para agregar fondos al saldo prepagado.
transaction_success_def" id="transaction_success_def">éxito de la transacción: , si se usa, indica que una transacción de API está monetizada o no. Esta variable se puede usar para anular el comportamiento predeterminado que se basa en el código de estado HTTP. Consulta Variables de monetización.

U

UAP

Plataforma de estadísticas unificada. Un servicio de Apigee en el plano de administración que procesa datos entrantes de estadísticas, depuración y estado de implementación, y que permite que estén disponibles a través de la IU de Apigee Hybrid o las API de Apigee.

Para obtener más información, consulta Recopilación de datos de depuración, estadísticas y estado de implementación.

UDCA

El agente universal de recopilación de datos es un servicio que se ejecuta dentro del pod de recopilación de datos en el plano del entorno de ejecución que extrae datos de estado de implementación, seguimiento y estadísticas y los envía a la UAP.

Para obtener más información, consulta Recopilación de datos de depuración, estadísticas y estado de implementación.

V

versión: La versión de la interfaz de API orientada al desarrollador. Por ejemplo, pivotaltracker.com/services/v3, or api.enterprise.apigee.com/v1. Este término es distinto a la revision, que es el paquete numerado y controlado por versión de políticas y configuraciones que se forma en un proxy de API. En resumen, las interfaces de API tienen versiones, mientras que los proxies de API tienen revisiones.
volumen: Almacenamiento compartido que pueden usar todas las aplicaciones alojadas en contenedores dentro de un pod.