Estás viendo la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Más información
Hay varios conceptos que son ideas comunes con un significado único en Apigee.
| Término | Definición |
|---|---|
| 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. |
| 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, debes definir una única URL raíz y varias rutas de recursos múltiples. 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 creadas por un proveedor de API. |
| Desarrollador de API | Un ingeniero de software de una organización de API de proveedor que compila API. Los desarrolladores de apps (consumidores de API) usan esas API para compilar aplicaciones. |
| Paquete de API | Una colección de productos de API que se presentan a los desarrolladores como un paquete y que, por lo general, se asocia a un plan de tarifas. |
| 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 en un paquete de API para monetización. |
| Proveedor de API | Un proveedor de API compila APIs (mediante Edge) para que las usen los consumidores de API (desarrolladores de apps). |
| Desarrollador de apps | En Edge, los desarrolladores de apps registran sus apps con un proveedor de API, que es la forma en que los desarrolladores de apps obtienen 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. |
| Detalles del saldo | En el caso de un desarrollador prepago, el saldo en la cuenta del desarrollador. |
| ajuste cerrado | Un ajuste que se aplicó en los documentos de facturación publicados. |
| mes de facturación cerrada | Un mes calendario completo para el que se publicaron documentos de facturación. |
| Límite personalizado | Un límite (como el límite en el número de transacciones en un producto de API) que puedes configurar de forma explícita mediante la monetización. También se denomina “límite explícito”. |
| 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. |
| agente divulgado | Según la ley comercial, una persona que está autorizada para actuar en nombre de otra (conocida como la principal) a fin de crear una relación legal con un tercero. En la monetización, se puede configurar un modelo fiscal para un plan de ingresos compartidos, de modo que el proveedor de la API actúe como agente divulgado del desarrollador para recaudar ingresos (y posiblemente impuestos de ventas) en nombre del desarrollador. |
| modelo fiscal divulgado | Un modelo fiscal en el que el proveedor de la API actúa como un agente divulgado del desarrollador. |
| entorno | Un contexto de ejecución del entorno de ejecución para las API. Una API debe implementarse en un entorno antes de que se pueda acceder a ella en el entorno de ejecución. De forma predeterminada, las organizaciones de Apigee se aprovisionan con dos entornos: “prueba” y “prod”. Por lo general, el entorno "test" se usa para implementar APIs que se someten a pruebas. Por lo general, el entorno de “prod” se usa a fin de implementar APIs para su uso en producción. |
| modelo fiscal híbrido | Un modelo fiscal en el que el proveedor de la API actúa como un agente divulgado del desarrollador. Sin embargo, el proveedor de la API paga el impuesto sobre las ventas que se recauda de los suscriptores a las autoridades fiscales locales en nombre del desarrollador. |
| límite implícito | Un límite (como un límite de saldo prepagado de un desarrollador) que establece la monetización. |
| Monetización | Componente de los servicios para desarrolladores de Apigee Edge 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. |
| declaración de redes | Un documento financiero que muestra los saldos netos entre las facturas y los resúmenes de ingresos. |
| 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”. |
| organización | Un contenedor para todos los objetos de tu cuenta de Apigee, incluidos API, productos de API, paquetes de API, aplicaciones y desarrolladores. Se requiere una cuenta de usuario para cada organización a la que perteneces. (La mayoría de los usuarios tendrá una cuenta en una sola organización). Debes proporcionar tus credenciales (nombre de usuario y contraseña) y el nombre de tu organización con cada solicitud de API que envíes. |
| catálogo de paquetes | Una lista de paquetes de API. Cada paquete se enumera con sus productos de API y planes de tarifas. |
| 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, examinar el contenido de los mensajes para detectar amenazas, almacenar en caché 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 (a través de una factura) por el uso de los productos de API. El desarrollador paga por el uso de los productos de API según las condiciones de pago establecidas por los planes incluidos en la factura. El proveedor de la API asigna el estado de prepago o pospago a los desarrolladores. |
| precios | Un rango de precios posibles en los que se podría comercializar algo. |
| Plan de tarifa de hojas de tarifa | Un plan de tarifas en el que se cobra al desarrollador una tarifa fija o variable por cada transacción asociada a un producto de API monetizado. |
| plan de tarifa | Una especificación de las tarifas, otros cargos y el reparto de ingresos por el uso de los productos de API que se ofrecen en un paquete de API monetizado |
| Ruta de acceso al recurso |
Un concepto de RESTful. Una ruta de acceso a un recurso es un recurso uniforme identificado (URI) que identifica la ruta de la red de un recurso determinado. |
| Plan de tarifa de reparto de ingresos | Un plan de tarifas en el que se comparte el desarrollador de la app que emite la solicitud con un porcentaje de los ingresos generados a partir de cada transacción. |
| plan de reparto de ingresos y hojas de tarifas | Un plan de tarifas en el que se comparte el desarrollador de la app que emite la solicitud con un porcentaje de los ingresos generados a partir de cada transacción. Al desarrollador también se le cobra una tarifa fija o variable por cada transacción. |
| factura de facturación automática | Un documento financiero que se genera en lugar de una declaración de reparto de ingresos. En ella, se detalla el importe que se le debe al programador y actúa como una factura para el proveedor de la API en nombre del programador. |
| Plan de tarifas estándar. | Un plan de tarifas que esté a la venta para todos los desarrolladores |
| impuesto | Los impuestos totales aplicados al uso y las tarifas de un desarrollador. |
| agrega dinero | Acción realizada por un desarrollador prepago para agregar fondos al saldo prepagado. |
| política de grabación de transacciones | Es un mecanismo que habilita la monetización para capturar parámetros de transacciones y atributos personalizados. La monetización necesita esta información para realizar el procesamiento de la monetización, como aplicar planes de tarifas a las solicitudes a la API y respuestas en función de los atributos personalizados capturados en cada transacción. |
| agente desconocido | Se trata de una organización (o un operador) que participa en el suministro subyacente de las aplicaciones, de modo que se considera que compra el contenido en nombre del desarrollador (solo con fines impositivos). Como agente no divulgado, la organización (u operador) puede recaudar y justificar los impuestos adeudados por los usuarios finales. Este estado solo es relevante para fines fiscales: el estado legal del desarrollador en la cadena de suministro no se ve afectado. |
| modelo fiscal no divulgado | Un modelo fiscal en el que el proveedor de la API deduce el impuesto que se les asigna a los usuarios finales y lo paga a las autoridades fiscales locales. |
| versión | La versión de la interfaz de API orientada al desarrollador. Por ejemplo, essentialtracker.com/services/v3 o api.enterprise.apigee.com/v1. (Este término es distinto a la "revisión", 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. |