Puerta de Enlace API Privada¶

Introducción¶

Una puerta de enlace API privada, alojada en una red privada, maneja estas funciones de seguridad y tareas involucradas en la aceptación y procesamiento API Manager API llama:

La gestión del tráfico.
Autorización y control de acceso.
Limitación de tarifas.
Procesamiento de carga útil API.

Puede instalar y ejecutar una puerta de enlace API privada en Linux, o ejecutar uno como un contenedor Docker basado en Linux.

Una puerta de enlace API privada es una puerta de enlace local para procesar APIs directamente desde sus propios servidores. Funciones de seguridad de API Manager están configurados en el nivel API o nivel de perfil de seguridad y se almacenan en caché en la puerta de enlace API privada, a la que luego se hace referencia durante el tiempo de ejecución de la API como se describe a continuación.

Arquitectura del Sistema de Puerta de Enlace API Privada¶

El uso de una puerta de enlace API privada proporciona estas ventajas adicionales sobre la puerta de enlace API en la nube:

Red interna: La puerta de enlace API privada y sus agentes pueden restringirse únicamente a una red interna detrás de un firewall y no ser accesibles desde Internet.

Nota

Si la instalación de su puerta de enlace API privada está detrás de un firewall dentro de su red, debe lista de permisos servicios Jitterbit necesarios.
Seguridad de carga útil: Las cargas útiles de respuesta API nunca pasan por los sistemas de Jitterbit.
Control: Usted tiene control sobre el ambiente de hardware y software de la puerta de enlace API privada, garantizando que cumpla con los estándares de su empresa.
Nombre de dominio: La URL del extremo de la API base se puede configurar para que sea un subdominio de un nombre de dominio que usted controle, en lugar de un subdominio de la región de Harmony (jitterbit.cc, jitterbit.eu, o jitterbit.net). Una alternativa al uso de una puerta de enlace API privada para controlar el nombre de dominio es utilizar una herramienta de externo como Cloudflare o un proxy DNS para enrutar un nombre de dominio personalizado a la URL base.

Este diagrama muestra la arquitectura del sistema de una API Personalizada implementada localmente con un agente privado y una puerta de enlace API privada:

Un consumidor de API realiza una llamada a la API ubicada en la puerta de enlace de API privada.
La puerta de enlace API privada hace referencia a los perfiles de seguridad almacenados en caché (si corresponde) y a los metadatos de API para realizar tareas de autenticación y control de acceso. Si se deniega el acceso a la API, la puerta de enlace de API privada devolverá una respuesta HTTP y un estado apropiados al consumidor de API. Si se concede acceso a la API, la solicitud de API se enruta al servicio de mensajería, que enruta las solicitudes para grupos de Agente.
El agente privado recibe la solicitud del servicio de mensajería.
El agente privado hace referencia a la operación API especificada durante la Configuración de API Personalizada y desencadena la operación desplegada.
La operación responde con una carga útil API consistente con el tipo de respuesta seleccionado durante la Configuración de API Personalizada.
La carga útil de la respuesta API se enruta desde el agente privado a la puerta de enlace API privada, que extrae la carga útil API y establece la respuesta y el estado HTTP finales. La respuesta y el estado HTTP se envían al consumidor de API.

Nota

A menos que la operación que se activa mediante la llamada API utilice Almacenamiento temporal, la carga útil de respuesta de API permanecerá en el agente durante un máximo de dos días. La carga útil de respuesta de API permanecerá en la puerta de enlace de API privada durante no más del tiempo de espera de la puerta de enlace de API de 15 segundos.
La información del estado del tiempo de ejecución y los registros de las operaciones en ejecución se envían a la base de datos de registros de transacciones.

Nota

Los datos del consumidor no se almacenan en la base de datos de registros de transacciones a menos que modo de depurar está habilitado durante la Configuración de API Personalizada.