Glosario de API Connect

El glosario de términos y definiciones de IBM® API Connect y Cloud Manager .

Administrador de API (rol): Gestiona el ciclo de vida del producto de API para las Organizaciones de proveedores de las que es miembro.
Suceso de API: Un evento que se captura para su uso por API Connect Analytics o análisis de terceros, como el tiempo de respuesta, HTTP código de respuesta, la carga útil de la solicitud y el cuerpo de la respuesta. Se registra un suceso de API cada vez que se invoca una operación de API a través del servidor de pasarela.
API Gateway: Servicio que actúa como punto de entrada único o “puerta principal” para las API de proveedor y los servicios de back-end. Una pasarela de API acepta y procesa llamadas de API simultáneas y lleva a cabo la gestión del tráfico, la autorización y el control de acceso, la supervisión y la gestión de la versión de la API. Consulte también #overview_apimgmt_glossary__dpgw.
Gestor de API: Herramienta gráfica en API Connect que le permite gestionar catálogos, espacios y API, usuarios y funciones en la organización de proveedores, organizaciones de consumidores y comunidades, publicar productos en el portal para desarrolladores y analizar el uso de las API.
API Designer: Herramienta gráfica que se ejecuta localmente en un sistema portátil o de escritorio que le permite crear y modificar las API y publicarlas en IBM Cloud o en entornos de ejecución de contenedor.
operación de API: Llamadas a la API REST compuestas por un verbo HTTP y una ruta URL (endpoint). Por ejemplo, GET http://myserver.com/api/users, que devuelve una lista de usuarios.
Aplicación: Software que consume (llama a) una API. Una organización de consumidores registra una o varias aplicaciones para suscribirse a las APIs. A la aplicación se le asigna el ID de cliente y las credenciales secretas de cliente que suministra al invocar las llamadas a la API.
ensamblaje: Realiza llamadas complementarias a servicios externos y, a continuación, transforma y agrega la respuesta antes de que se transmita una respuesta a la aplicación de llamada.
Zonas de disponibilidad: En API Connect , son agrupaciones lógicas de servicios API Connect que normalmente reflejarán el entorno de despliegue. Por ejemplo, puede tener zonas de disponibilidad denominadas internal y external para reflejar las API publicadas en cada una de ellas. O pueden estar definidos por la ubicación geográfica en la que se ejecutan los servicios.
Catálogo: Un destino de transición que se comporta como una partición lógica de la pasarela y el Portal del desarrollador. Las URL para las llamadas a la API y para el Portal del Desarrollador son específicas de un catálogo concreto.
ID de cliente: Información que identifica una aplicación individual. Una aplicación sólo puede invocar una API si pasa una clave de aplicación reconocida por el sistema IBM API Connect y se le otorga acceso a la API. El cliente pasa la clave de aplicación utilizando un parámetro de consulta HTTP.
secreto de cliente: Información que se utiliza junto con la clave de aplicación para verificar la identidad de una aplicación. Una API se puede configurar para que sea necesario que las aplicaciones cliente proporcionen el secreto de cliente con su ID de cliente. El secreto de cliente funciona efectivamente como una contraseña que sólo conoce la aplicación. El cliente pasa el secreto de cliente utilizando un parámetro de consulta HTTP.
clúster: Recopilación de uno o más servidores que proporcionan una función específica.
Espera en frío: Una configuración de despliegue en la que los servidores de migración están en estado detenido hasta que se requiere una migración tras error, lo que resulta en una ventana temporal más larga para restaurar el funcionamiento normal de la solución.
comunidad: Recopilación de organizaciones de consumidores. Se utiliza como una construcción de agrupación cuando se publican API. Las comunidades se utilizan para restringir la visibilidad y la accesibilidad de las API. Una API se puede publicar en comunidades seleccionadas, lo que significa que solo los desarrolladores de aplicaciones de dichas organizaciones pueden ver la API.
Gestor de comunidad (rol): Gestiona las comunidades de desarrolladores de aplicaciones para las organizaciones de proveedores de las que son miembros.
Organización de consumidores: Dentro de un catálogo, representación de una entidad empresarial que desea consumir las API expuestas por el catálogo. Por ejemplo, una empresa de desarrollo de aplicaciones de terceros se registraría como una organización de consumidores (a través del Portal del desarrollador). Cada desarrollador de la empresa se puede registrar como usuario dentro de esa organización de consumidores.
Desarrollador (rol): Crea y configura APIs, productos y políticas para las organizaciones de proveedores de las que son miembros. Un desarrollador de API puede ser miembro de una o más organizaciones de proveedores. El desarrollador de API se centra más en la implementación técnica de las API que en la relación comercial con los desarrolladores de aplicaciones.
Catálogo de desarrollo: Catálogo utilizado para probar APIs que están en desarrollo y donde se omiten las aprobaciones para acciones de publicación y ciclo de vida. Las aprobaciones pendientes se cancelan cuando un catálogo que no es de desarrollo se convierte en un catálogo de desarrollo.
Portal del desarrollador: Componente de API Connect que proporciona un portal web gráfico personalizable para que los desarrolladores descubran las API, registren las aplicaciones que consumen las API, se suscriban a planes de uso y prueben y utilicen las API.
Kit de herramientas de desarrollador: Paquete instalado localmente que incluye API Designer y la herramienta de línea de comandos apic , que permite crear, editar, gestionar y publicar API y aplicaciones.
Pasarela: Ver API Gateway.
Servicio de pasarela: Servicio de API Connect que proporciona funcionalidad de pasarela de API, como por ejemplo microgateway o IBM DataPower®.
Espera activa: Una configuración de despliegue en la que un conjunto de servidores se están ejecutando activamente listos para tomar el control en el caso de una anomalía, pero que no dan servicio activamente al tráfico hasta que se produce esa migración tras error.
Integraciones: Herramientas de terceros para ampliar y mejorar su flujo de trabajo en API Connect ; por ejemplo, Slack, Auth0, etc.
Perfil de integración: API estándar que puede utilizar para integrarse con servicios de gestión para cosas como identidad, notificaciones, análisis de API.
Almacén de claves: Un repositorio de certificados de seguridad, ya sean certificados de autorización o certificados de clave pública, y sus correspondientes claves privadas, que se utilizan en el cifrado SSL. El archivo de almacén de claves tiene una extensión .jks.
servidor de gestión: Almacena toda la configuración de nube y controla la comunicación entre los otros servidores dentro de API Connect.
Servicio de gestión: Consta de uno o varios servidores de gestión.
Miembro (rol): El rol predeterminado para todos los usuarios, tanto en la organización de administración como la organización de proveedores. A todos los usuarios se les asigna la función de Miembro, además de otras funciones que puedan necesitar.
microservicio: Servicio de aplicación modular e independiente que se comunica con otros microservicios a través de una API REST. Los microservicios se organizan normalmente alrededor de las prestaciones, por ejemplo, recomendación, inventario, envío o facturación.
Autenticación mutua: Proceso en el que ambas entidades de una red se autentican entre sí. En un entorno de red, el cliente autentica al servidor y viceversa. Es opcional para TLS. También se conoce como autenticación bidireccional.
Valores de notificación: Cómo configurar notificaciones para usuarios de API Connect (proveedores y consumidores de API).
Servicios de notificación: Integraciones que proporcionan prestaciones de notificación, como por ejemplo correo electrónico.
Plantillas de notificación: La configuración del formato del mensaje y el texto para un servicio de notificación.
Proveedor de OAuth: El proveedor de OAuth proporciona la autenticación OAuth para los inicios de sesión. API Connect admite proveedores de OAuth nativos y de terceros. Algunos proveedores de OAuth de terceros habituales son Google y Facebook.
Componentes de OpenAPI: Parte de la especificación de la API que contiene un conjunto de objetos reutilizables para aspectos de una especificación de API, como por ejemplo, esquemas, respuestas, cuerpos de solicitud y cabeceras. Para obtener más información, consulte [Especificación de OpenAPI v3]( https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#components-object).
organización: La entidad que posee las API o aplicaciones que utilizan las API. Una organización proveedora es propietaria de API y Planes asociados, y también puede ser propietaria de aplicaciones. Una organización de consumidores sólo posee aplicaciones. Una organización tiene por lo menos un propietario. Una organización puede ser un equipo de proyecto, un departamento o una división.
Gestor de organización (rol): El Gestor de organización gestiona las organizaciones de proveedores de la organización de administración.
Vía de acceso: Define la ruta a través de la cual los usuarios acceden a las API REST. Una vía de acceso consta de una o varias operaciones de HTTP, como GET o POST.
Planifique: La construcción empaquetada mediante la cual las API pasan a estar a disposición de los desarrolladores. Un plan hace que una recopilación de operaciones de una o más API esté disponible y se publica en comunidades de desarrolladores de aplicaciones. Los desarrolladores de aplicaciones obtienen acceso a las API registrando aplicaciones para acceder a los planes. Un plan incluye una recopilación de valores de política. En la forma más simple, un plan define una política de cuota única que se aplica a todas las operaciones a las que se accede a través del plan. En casos más avanzados, se pueden asociar políticas adicionales con un plan.
política: Una configuración que controla una aspecto concreto del proceso en el servidor de pasarela durante el manejo de una invocación de API en el tiempo de ejecución. Las políticas son los bloques de construcción de flujos de ensamblaje. Las políticas proporcionan los medios para configurar la capacidad, por ejemplo seguridad, registro, direccionamiento de solicitudes a servicios de destino y transformación de datos de un formato a otro. Las políticas se pueden configurar en el contexto de una API o en el contexto de un plan.
Producto: Proporcionan un método mediante el cual puede agrupar las API en un paquete que está pensado para un uso concreto. Además, contienen Planes, que pueden utilizarse para diferenciar entre distintas ofertas. Solo puede crear planes dentro de los productos, y estos productos se publican en un catálogo.
Propietario de organización de proveedores: Posee y administra organizaciones de proveedores de API, gestiona comunidades de desarrolladores de aplicaciones, crea APIs y define productos, gestiona el ciclo de vida del producto de la API. El administrador de nube invita a los propietarios a unirse a API Connect como propietario de una organización de proveedores.
proxy: Interfaz de programación de aplicaciones que reenvía solicitudes a un recurso de fondo definido por el usuario y retransmite las respuestas a la aplicación de llamada.
Región: Una ubicación física (sitio o centro de datos) que aloja una infraestructura aislada de otras ubicaciones, con energía independiente y conectividad de red. Una región puede tener o no otras características de subaislamiento, como vainas semiindependientes o zonas de disponibilidad.
Recursos (registros de usuarios, perfiles de TLS, notificaciones): Los recursos suministran funciones necesarias para la API Connect nube, como la autenticación de usuarios, la seguridad SSL y el envío de correos electrónicos generados por el sistema.
rol: Define los permisos que pueden habilitar la funcionalidad para los usuarios. Cada rol tiene un conjunto de permisos distinto.
definición de seguridad: Especifica todos los valores para un aspecto concreto de la seguridad de la API; por ejemplo, el registro de usuarios que se utiliza para autenticar el acceso a la API.
servidor: Un único dispositivo, como un dispositivo IBM WebSphere IBM DataPower .
Servicio: Elemento configurable por el usuario que se implementa a través de uno o varios procesos de servidor en el tiempo de ejecución de API Connect , como microgateway, Analytics, IBM DataPower y Developer Portal.
SNMP: El protocolo SNMP (Simple Network Management Protocol) es un protocolo de gestión de redes. Se utiliza para configurar y recopilar información de dispositivos de red, como por ejemplo servidores, impresoras, concentradores, conmutadores y direccionadores en una red IP (Protocolo Internet). Los hosts SNMP se configuran en API Connect Cloud Manager.
Espacio: Una subdivisión de un catálogo. Cada Espacio lo utiliza un equipo diferente de desarrollo de proveedores de API y tiene su propio conjunto de prestaciones de gestión relacionadas específicamente con las API que el equipo asociado publica en ese espacio, lo que permite a cada equipo gestionar las API correspondientes de forma independiente.
Perfil SSL (TLS): Los perfiles SSL/TLS se utilizan para proteger la transmisión de datos a través de sitios web. Los certificados SSL garantizan que no se pueda robar o falsificar la información que se envía a sitios web.
suscripción: Medio mediante el cual un desarrollador de aplicaciones obtiene acceso a los recursos proporcionados por una API. Un desarrollador de aplicaciones utiliza el Portal del desarrollador para suscribirse al plan en el que se publica la API.
TLS: Seguridad de la capa de transporte: un protocolo criptográfico que proporciona comunicación segura a través de una red para impedir las escuchas no autorizadas y la manipulación indebida. Es un sucesor de SSL y se ejecuta a través TCP.
Perfiles TLS: Cloud Manager y API Manager utilizan perfiles TLS para proteger la transmisión de datos a través de sitios web. Los certificados TLS garantizan que la información que envíe a los sitios web no será robada ni manipulada. Un perfil de TLS consta de un nombre de servidor, el protocolo utilizado (SSL o TLS) y de si se necesita autenticación mutua.
Kit de herramientas: Consulte Kit de herramientas de desarrollador.
Almacén de confianza: Almacena certificados de autoridades de certificación (CA) de confianza, que se utilizan para verificar los certificados presentados por el servidor en la conexión SSL/TSL. Mientras que un almacén de claves almacena las credenciales de un servidor, el almacén de confianza almacena certificados de una entidad emisora de certificados CA de terceros.
ampliación de proveedor: Una ampliación de la especificación OpenAPI (Swagger) necesaria para un caso de uso determinado.
Visibilidad: El establecimiento de la visibilidad determina si una organización de proveedores tiene acceso a una zona de disponibilidad o a otro servicio.