Tipos de API no Jitterbit API Manager
Visão geral
No API Manager, você pode criar e publicar três tipos de APIs:
Cada tipo de API interage com o Harmony exclusivamente dentro da arquitetura do sistema, conforme descrito abaixo.
Para obter mais informações sobre a segurança e a arquitetura do sistema Jitterbit, consulte white paper sobre segurança e arquitetura do Jitterbit.
API customizada
APIs personalizadas expõem uma operação Harmony para consumo. Uma operação deve primeiro ser criada e implantada no Harmony e pode ser qualquer Integration Studio ou Design Studio operação. A operação existente é então referenciada durante a configuração da API personalizada e é chamada e consumida por um consumidor de API. APIs personalizadas são roteadas por meio de agentes Jitterbit (grupos de agentes de nuvem ou agentes privados).
Este diagrama exibe como uma API personalizada se comporta na arquitetura do sistema quando implantada com um agente de nuvem e um gateway de API de nuvem:
-
Um consumidor de API faz uma chamada para a API personalizada localizada no cloud API gateway.
-
A solicitação de API personalizada é roteada pelo gateway de API na nuvem para o serviço de mensagens, que roteia solicitações para grupos de agentes.
-
Um agente de nuvem recebe a solicitação do serviço de mensagens.
-
O agente de nuvem faz referência à operação de API personalizada especificada durante a configuração de API personalizada e aciona a operação implantada.
-
A operação responde com uma payload de API consistente com o tipo de resposta selecionado durante a configuração de API personalizada.
-
A payload da API é roteada do agente de nuvem de volta para o consumidor da API.
Nota
A menos que a operação acionada pela chamada de API esteja usando Armazenamento Temporário, a payload da API permanecerá no agente por apenas dois dias.
-
As informações de status de tempo de execução e os logs das operações em execução são enviados ao banco de dados de logs de transações.
Nota
Os dados do consumidor não são armazenados no banco de dados de logs de transações, a menos que modo de depurar é habilitado durante configuração de API personalizada.
Para obter informações sobre como configurar uma API personalizada, consulte Configuração de API customizada.
Serviço OData
Os serviços OData expõem um Design Studio operação de entidade de API para consumo. A operação de entidade da API deve primeiro ser criada e implantada no Harmony. A operação de entidade da API existente é então referenciada durante a configuração do serviço OData e é chamada e consumida por um consumidor da API. Os serviços OData são roteados por meio de agentes Jitterbit (grupos de agentes de nuvem ou agentes privados).
Este diagrama exibe como um serviço OData se comporta na arquitetura do sistema quando implantado no local com um agente privado e um gateway de API privado:
-
Um consumidor de API faz uma chamada para o serviço OData localizado no gateway de API privado.
-
A solicitação de serviço OData é roteada por meio do gateway de API privado.
-
A solicitação é recebida pelo serviço de mensagens, que encaminha solicitações para grupos de agentes.
-
O agente privado recebe a solicitação do serviço de mensagens.
-
O agente privado faz referência à operação de entidade da API do serviço OData no Harmony e aciona a operação de entidade implantada.
-
A operação responde com uma payload de API que é roteada do agente privado por meio do gateway de API privado de volta ao consumidor de API.
Nota
A menos que a operação acionada pela chamada de API esteja usando Armazenamento Temporário, a payload da API permanecerá no agente por apenas dois dias.
-
As informações de status de tempo de execução e os logs das operações em execução são enviados ao banco de dados de logs de transações no agente privado.
Nota
Os dados do consumidor não são armazenados no banco de dados de logs de transações, a menos que modo de depurar é habilitado durante configuração do serviço OData.
-
Os logs no agente privado podem ser sincronizados opcionalmente com o banco de dados de logs de transações no Harmony.
Para obter informações sobre como configurar um serviço OData, consulte Configuração do serviço OData.
Proxy de API
Ao contrário de APIs personalizadas ou serviços OData, que expõe uma operação Harmony para consumo, as APIs de proxy são usadas com uma API de externo existente e não são roteadas por meio de agentes Jitterbit. A API que está sendo proxyada deve ser acessível ao gateway que processa a API, seja o gateway da API de nuvem ou um gateway de API privado:
-
Gateway da API da nuvem: Se estiver usando o gateway da API que o Jitterbit hospeda no Harmony, a API existente deve ser acessível publicamente, mesmo se protegida. Ou seja, a API que você está tentando usar como proxy não pode estar atrás de um firewall. Para permitir que os endereços IP do gateway da API da nuvem lista de permissões para permitir que o gateway acesse a API que está sendo usada como proxy, consulte Informações da lista de permissões e navegue até
https://services.jitterbitpara sua região. -
Gateway de API privado: Se estiver usando um gateway de API privado, a API existente deve ser acessível pelo gateway de API privado.
Este diagrama exibe como uma API proxy se comporta na arquitetura do sistema quando processada pelo gateway da API na nuvem:
-
Um consumidor de API faz uma chamada para a API proxy localizada no cloud API gateway.
-
A chamada da API proxy é roteada pelo gateway da API na nuvem e enviada para a API de externo que está sendo proxyada.
-
A payload da API é roteada pelo gateway da API na nuvem de volta ao consumidor da API.
-
A API de externo responde com uma payload de API que é roteada para o gateway de API na nuvem de volta ao consumidor da API.
-
As informações de status do tempo de execução são enviadas ao banco de dados de logs de transações.
Nota
Os dados do consumidor não são armazenados no banco de dados de logs de transações, a menos que modo de depurar é habilitado durante configuração da API do proxy.
Para obter informações sobre como configurar uma API de proxy, consulte Configuração da proxy de API.