Terminología básica

Una interfaz de programación de aplicaciones: una interfaz que facilita que una aplicación consuma las funciones o los datos de otra aplicación.

Mediante la definición de puntos de entrada estables y simplificados en los datos y la lógica de la aplicación, las API permiten a los desarrolladores acceder con facilidad a la lógica de aplicación que compilaron otros desarrolladores y volver a usarla. En el caso de las API web, la lógica y los datos se exponen en la red. Ya que las aplicaciones que consumen API son sensibles a los cambios, las API también implican un contrato. El contrato proporciona un cierto nivel de garantía de que, con el tiempo, la API cambiará de manera predecible.

Apigee proporciona una gran cantidad de información sobre las API y recomendaciones para desarrollarlas y consumirlas. Para comenzar, mira la transmisión web sobre diseño de API o descarga el libro electrónico gratuito Diseño de API web: Prácticas recomendadas sobre los vínculos faltantes para crear interfaces que los desarrolladores adoran.

Una fachada en Edge para una o más APIs, servicios HTTP genéricos o aplicaciones (como Node.js)

Un proxy de API se implementa como un conjunto de archivos de configuración, políticas y código que dependen de un conjunto de recursos que proporciona Apigee Edge. Los proxies de API pueden generarse y configurarse mediante la IU de administración de Apigee Edge, o pueden implementarse de forma local en un editor de texto o IDE.

La fachada proporcionada por un proxy de API separa la API orientada al desarrollador de los servicios de backend, a fin de proteger a los desarrolladores contra los cambios de código y permitir la innovación en el perímetro sin afectar a tus equipos de desarrollo interno. A medida que los equipos de desarrollo realizan cambios en el backend, los desarrolladores continúan llamando a la misma interfaz sin interrupciones. Apigee te permite exponer varias interfaces a la misma API, lo que te permite personalizar la firma de una API para satisfacer las necesidades de varios nichos de desarrollador de forma simultánea.

API definidas por direcciones de red y URI. Una API se compone de una ruta base y un conjunto de recursos de la API. Cada proxy de API define una ruta base y, opcionalmente, varias rutas de recursos de API. 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. Edge te permite adjuntar políticas y código a los URI, lo que permite controlar y administrar los comportamientos de tus API de forma detallada.

Es una colección de recursos de API (URI) combinada con una cuota, o plan de servicios, que se publica para los desarrolladores de apps en el momento del diseño. A su vez, los productos de API se pueden agrupar en paquetes de API para la monetización.

Una clave de API está vinculada a uno o más productos de API, aplicando una vinculación entre una aplicación y el paquete de URI que la aplicación puede consumir.

Abreviatura de aplicación. El término app se refiere a aplicaciones para dispositivos móviles que consumen API. Los desarrolladores implementan apps en una variedad de lenguajes de programación y usan diversas tecnologías y plataformas. Los desarrolladores que deseen consumir API registran aplicaciones en una organización de proveedor de API en Apigee Edge.

Cuando se registra la aplicación, Apigee genera una clave de API y un Secret que identifican la aplicación. El desarrollador incorpora la clave de API en la aplicación, y esta presenta la clave cuando se realizan solicitudes. Los servicios de API implementan la seguridad en torno a la clave de API mediante la validación directa de la API o mediante OAuth.

Un contexto de ejecución del entorno de ejecución para los proxies de API. Se debe implementar un proxy de API en un entorno antes de que la API que expone sea accesible a través de la red. De forma predeterminada, las organizaciones se aprovisionan con dos entornos: prueba y prod.

• Por lo general, el entorno de prueba se usa para implementar proxies de API durante el desarrollo.
• El entorno prod generalmente se usa para promover proxies de API desde el entorno de pruebas después de que se desarrollaron y probaron por completo.

Un contenedor para todos los objetos en una cuenta de Apigee Edge, incluidos los proxies de API, los productos de API, los paquetes de API, las aplicaciones y los desarrolladores.

Se necesita 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).

Un paso de procesamiento que se ejecuta como una unidad de lógica atómica y reutilizable dentro de un flujo de procesamiento de proxy de API.

La funcionalidad típica basada en políticas incluye la transformación de formatos de mensajes, la aplicación del control de acceso, la llamada a servicios remotos para obtener información adicional, el enmascaramiento de datos sensibles de usuarios externos, el análisis del contenido de los mensajes para detectar amenazas potenciales y el almacenamiento en caché de respuestas comunes para mejorar el rendimiento, etc.

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.

La versión de la interfaz de API orientada al desarrollador.

Por ejemplo, pivotaltracker.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. Las interfaces de API tienen versiones; los proxies de API tienen revisiones.