Tipos de API do 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 segurança e arquitetura do sistema Jitterbit, consulte documento técnico sobre segurança e arquitetura 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 Cloud 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 Harmony (grupos de agentes de nuvem ou agentes privados).
Este diagrama mostra como uma API personalizada se comporta na arquitetura do sistema quando implementada 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 gateway de API da nuvem.
-
A solicitação de API personalizada é roteada por meio do gateway de API da 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 que está sendo 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 do 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 é ativado 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 API para consumo. A operação da entidade API deve primeiro ser criada e implantada no Harmony. A operação da entidade API existente é então referenciada durante a configuração do serviço OData e é chamada e consumida por um consumidor API. Os serviços OData são roteados por meio de agentes Harmony (grupos de agentes de nuvem ou agentes privados).
Este diagrama mostra como um serviço OData se comporta na arquitetura do sistema quando implantado localmente 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 roteia 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 da entidade API do serviço OData no Harmony e aciona a operação da entidade implantada.
-
A operação responde com uma payload de API que é roteada do agente privado através do gateway de API privado de volta ao consumidor da API.
Nota
A menos que a operação que está sendo 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 do 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 do agente privado podem ser opcionalmente sincronizados 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õem 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 Harmony. A API que está sendo proxy deve estar acessível ao gateway que processa a API, seja o gateway de API da nuvem ou um gateway de API privado:
-
Gateway API da nuvem: Se estiver usando o gateway API que o Jitterbit hospeda no Harmony, a API existente deverá estar acessível publicamente, mesmo que segura. Ou seja, a API que você está tentando fazer proxy não pode estar atrás de um firewall. Para lista de permissões os endereços IP do gateway da API da nuvem para permitir o acesso do gateway à API que está sendo 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 deverá estar acessível pelo gateway de API privado.
Este diagrama mostra como uma API proxy se comporta na arquitetura do sistema quando processada pelo gateway de API em nuvem:
-
Um consumidor de API faz uma chamada para a API proxy localizada no gateway da API da nuvem.
-
A chamada da API do proxy é roteada por meio do gateway da API da nuvem e enviada para a API de externo que está sendo proxy.
-
A payload da API é roteada através do 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 da 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 é ativado durante configuração da API de proxy.
Para obter informações sobre como configurar uma API de proxy, consulte Configuração da proxy de API.