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 Jitterbit e arquitetura do sistema, consulte Jitterbit Security and Architecture White Paper.
API Customizada¶
As APIs customizadas expõem uma operação do 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 é referenciada durante a configuração da API Customizada e é chamada e consumida por um consumidor de API. As APIs personalizadas são roteadas por meio de Harmony Agents (Grupos de Agentes em Nuvem ou Agentes Privados).
Este diagrama mostra como uma API Customizada se comporta na arquitetura do sistema quando implantada com um Agente em Nuvem e um Gateway de API em Nuvem:
-
Um consumidor de API faz uma chamada para a API Customizada localizada no Gateway de API em Nuvem.
-
A solicitação de API Customizada é roteada por meio do Gateway de API em Nuvem para o serviço de mensagens, que roteia solicitações para grupos de Agente.
-
Um Agente em Nuvem recebe a solicitação do serviço de mensagens.
-
O Agente em Nuvem faz referência à operação de API Customizada especificada durante a Configuração de API Customizada 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 Customizada.
-
A payload da API é roteada do Agente em 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.
-
Informações de status de tempo de execução e logs de operações em execução são enviados para o banco de dados de logs de transação.
Nota
Os dados do consumidor não são armazenados no banco de dados de logs de transação, a menos que modo de depurar é ativado durante Configuração de API Customizada.
Para obter informações sobre como configurar uma API Customizada, consulte Configuração de API Customizada.
Serviço OData¶
OData Services expõe um Design Studio operação de entidade API para consumo. A operação da entidade API deve primeiro ser criada e implementada no Harmony. A operação de entidade de API existente é então referenciada durante a configuração do Serviço OData e é chamada e consumida por um consumidor de API. Os serviços OData são roteados através de Harmony Agents (seja Grupos de Agentes em Nuvem ou Agentes Privados).
Este diagrama mostra 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 do Serviço OData é roteada por meio do Gateway de API Privado.
-
A solicitação é recebida pelo serviço de mensagens, que encaminha as solicitações para Grupos de Agente.
-
O Agente Privado recebe a solicitação do serviço de mensagens.
-
O Agente Privado faz referência à operação da entidade da API do Serviço OData no Harmony e aciona a operação da entidade implantada.
-
A operação responde com uma payload da API que é roteada do Agente Privado por meio do Gateway de API Privado de volta ao 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 do tempo de execução e os logs das operações em execução são enviados para o banco de dados de logs de transação no Agente Privado.
Nota
Os dados do consumidor não são armazenados no banco de dados de logs de transação, a menos que modo de depurar é ativado durante a configuração do Serviço OData.
-
Os logs no Agente Privado podem ser opcionalmente sincronizados com o banco de dados de logs de transação dentro do 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 das APIs personalizadas ou Serviços OData, que expõem uma operação do Harmony para consumo, as APIs do Proxy são usadas com uma API de externo existente e não são roteadas por meio dos Agentes do Harmony. A API que está sendo proxy deve estar acessível para o gateway que processa a API, seja o Gateway de API em Nuvem ou um Gateway de API Privado:
-
Gateway de API em Nuvem: Se estiver usando o API gateway 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 fazer proxy não pode estar protegida por um firewall. Para lista de permissões a lista de endereços IP do Gateway de API em 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 deve ser acessível pelo Gateway de API Privado.
Este diagrama mostra como uma proxy de API se comporta na arquitetura do sistema quando processada pelo Gateway de API em Nuvem:
-
Um consumidor de API faz uma chamada para a API de proxy localizada no Gateway de API em Nuvem.
-
A chamada de API de proxy é roteada por meio do Gateway de API em Nuvem e enviada para a API de externo que está sendo proxy.
-
A payload da API é roteada por meio do Gateway de API em Nuvem de volta ao consumidor da API.
-
A API de externo responde com uma payload da API que é roteada para o Gateway de API em Nuvem de volta ao consumidor da API.
-
As informações de status do tempo de execução são enviadas para o 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ção, a menos que modo de depurar é ativado durante a configuração da proxy de API.
Para obter informações sobre como configurar uma proxy de API, consulte Configuração da proxy de API.