Tipos de API en Jitterbit API Manager
Descripción general
Dentro de API Manager, puedes crear y publicar tres tipos de APIs:
Cada tipo de API interactúa con Harmony de forma única dentro de la arquitectura del sistema como se describe a continuación.
Para obtener más información sobre la seguridad y la arquitectura del sistema Jitterbit, consulte el documento técnico sobre seguridad y arquitectura Jitterbit.
API personalizada
Las APIs personalizadas exponen una operación de Harmony para su consumo. Primero se debe crear e desplegar una operación en Harmony y puede ser cualquier Integration Studio o Design Studio operación. Luego, se hace referencia a la operación existente durante la configuración de la API personalizada y un consumidor de API la llama y la consume. Las APIs personalizadas se enrutan a través de agentes Jitterbit (ya sea grupos de agentes de la nube o agentes privados).
Este diagrama muestra cómo se comporta una API personalizada en la arquitectura del sistema cuando se implementa con un agente de nube y una puerta de enlace de API de nube:
-
Un consumidor de API realiza una llamada a la API personalizada ubicada en la puerta de enlace de API en la nube.
-
La solicitud de API personalizada se enruta a través de la puerta de enlace de API en la nube al servicio de mensajería, que enruta las solicitudes para los grupos de agentes.
-
Un agente de nube recibe la solicitud del servicio de mensajería.
-
El agente de la nube hace referencia a la operación de API personalizada especificada durante la configuración de API personalizada y desencadena la operación implementada.
-
La operación responde con una carga útil de API consistente con el tipo de respuesta seleccionado durante la configuración de API personalizada.
-
La carga útil de la API se enruta desde el agente de nube al consumidor de la API.
Nota
A menos que la operación que se activa mediante la llamada API esté usando Almacenamiento temporal, la carga útil de la API permanecerá en el agente solo durante dos días.
-
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.
Para obtener información sobre cómo configurar una API personalizada, consulte Configuración de API personalizada.
Servicio OData
Los servicios OData exponen una operación de entidad API de Design Studio para el consumo. La operación de entidad API debe crearse primero e desplegarse en Harmony. Luego, se hace referencia a la operación de entidad API existente durante la configuración del servicio OData y un consumidor API la llama y la consume. Los servicios OData se enrutan a través de agentes Jitterbit (ya sea grupos de agentes de la nube o agentes privados).
Este diagrama muestra cómo se comporta un servicio OData en la arquitectura del sistema cuando se implementa localmente con un agente privado y una puerta de enlace de API privada:
-
Un consumidor de API realiza una llamada al servicio OData ubicado en la puerta de enlace de API privada.
-
La solicitud del servicio OData se enruta a través de la puerta de enlace API privada.
-
La solicitud es recibida por el servicio de mensajería, que enruta las solicitudes para los grupos de agentes.
-
El agente privado recibe la solicitud del servicio de mensajería.
-
El agente privado hace referencia a la operación de entidad API del servicio OData en Harmony y activa la operación de entidad implementada.
-
La operación responde con una carga útil de API que se enruta desde el agente privado a través de la puerta de enlace de API privada hasta el consumidor de API.
Nota
A menos que la operación que se activa mediante la llamada API esté usando Almacenamiento temporal, la carga útil de la API permanecerá en el agente solo durante dos días.
-
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 en el agente privado.
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 del servicio OData.
-
Los registros del agente privado se pueden sincronizar opcionalmente con la base de datos de registros de transacciones dentro de Harmony.
Para obtener información sobre cómo configurar un servicio OData, consulte Configuración del servicio OData.
Proxy de API
A diferencia de las APIs personalizadas o servicios OData, que exponen una operación de Harmony para su consumo, las APIs proxy se utilizan con una API de externo existente y no se enrutan a través de agentes Jitterbit. La API que se está redirigiendo debe ser accesible para la puerta de enlace que procesa la API, ya sea la puerta de enlace de API en la nube o una puerta de enlace de API privada:
-
Puerta de enlace de API en la nube: Si se utiliza la puerta de enlace de API que Jitterbit aloja en Harmony, la API existente debe ser accesible públicamente, incluso si está protegida. Es decir, la API que intentas utilizar como proxy no puede estar detrás de un firewall. Para lista de permisos las direcciones IP de la puerta de enlace de API en la nube para permitir que la puerta de enlace acceda a la API que se está utilizando como proxy, consulta Información sobre la lista de permitidos y navegar a
https://services.jitterbitpara su región. -
Puerta de enlace de API privada: Si se utiliza una puerta de enlace de API privada, la API existente debe ser accesible mediante la puerta de enlace de API privada.
Este diagrama muestra cómo se comporta una API de proxy en la arquitectura del sistema cuando la procesa la puerta de enlace de API en la nube:
-
Un consumidor de API realiza una llamada a la API proxy ubicada en la puerta de enlace de API en la nube.
-
La llamada a la API del proxy se enruta a través de la puerta de enlace de API en la nube y se envía a la API de externo que se está proxyizando.
-
La carga útil de la API se enruta a través de la puerta de enlace de API en la nube hasta el consumidor de API.
-
La API de externo responde con una carga útil de API que se enruta a la puerta de enlace de API en la nube y de regreso al consumidor de API.
-
La información sobre el estado del tiempo de ejecución se envía 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 la API de proxy.
Para obtener información sobre cómo configurar una API de proxy, consulte Configuración de proxy de API.