Gerenciamento de API baseado em eventos – captura de dados de mudança

Gerenciamento de API baseado em eventos – captura de dados de mudança

cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br


alterar captura de dados
alterar captura de dados

Apresentamos anteriormente por que APIs orientadas a eventos são importantes no blog APIFriends. Então, na semana passada, apresentei a necessidade de gerenciamento de API orientado a eventos, quais recursos são esperados e como Axway pode ajudar.

Resumindo, o Event-Driven API Management é a combinação do AMPLIFY ™ API Management e AMPLIFY ™ Streams v2, com algumas configurações para uma integração perfeita.

Vamos ver o gerenciamento de API baseado em eventos em ação!

Este é nosso primeiro exemplo: Use um webhook para receber notificações para cada alteração. Ou um nome melhor: Change Data Capture.

Caso de uso

Vamos usar muito API Petstore bem conhecida, de swagger.io. Dessa forma, fica claro que isso pode funcionar para qualquer API!

A API Petstore tem muitos métodos, especialmente um método para adicionar um animal de estimação e outro para localizar animais de estimação disponíveis.

Nosso aplicativo precisa saber quando um novo animal de estimação está disponível. Por se tratar de um serviço remoto, não há como modificar o serviço ou atender os demais consumidores. A única solução viável é fazer pesquisas frequentes para obter notícias “frescas”.

Gerenciamento de API baseado em eventos - captura de dados de mudança 2

No entanto, isso é abaixo do ideal por muitos motivos. Em primeiro lugar, o aplicativo precisará manter uma cópia da resposta anterior para deduzir as diferenças. Parece possível, mas vários detalhes técnicos precisam ser resolvidos.

Em seguida, cada consumidor teria que fazer isso por conta própria; e isso não é amigável ao consumidor. Finalmente, da perspectiva do serviço, isso causa muitas pesquisas e desperdício de recursos.

Leia Também  Tecnologia Axway | Mudando o mundo com um hack

Portanto, graças ao Gerenciamento de API orientado a eventos (EDAM), podemos gerar um webhook a partir de uma API REST:

Gerenciamento de API baseado em eventos - captura de dados de mudança 3

O aplicativo agora pode simplesmente se inscrever no webhook e receber notificações.

Sim, ainda há pesquisas, mas apenas por um consumidor (EDAM), mesmo que haja 1.000 assinantes.

Como funciona?

Existem 3 etapas:

Gerenciamento de API baseado em eventos - captura de dados de mudança 4

  • Fase de administração do API Manager: APIM Admin virtualiza Petstore API, define opções e gera uma API de inscrição de webhook Petstore.
  • Fase de desenvolvedor de aplicativos: O desenvolvedor do aplicativo se conecta ao Portal API, procura a API de assinatura do webhook e registra o aplicativo.
  • Fase de tempo de execução: Todas as interações são visíveis por meio do monitoramento APIM. Quando ocorre uma alteração, o Streams v2 a detecta e envia uma notificação pelo webhook.

Fase de administração do API Manager

O APIM Admin virtualiza a API Petstore, como qualquer API REST.

Gerenciamento de API baseado em eventos - captura de dados de mudança 5

O APIM abre a API, vai até a guia “API” e encontra o seguinte painel:

Gerenciamento de API baseado em eventos - captura de dados de mudança 6

APIM Admin usa para definir se e como uma API orientada a eventos é gerada. O “se” é “Streamificação?” caixa de seleção. O “como” são todas as outras caixas. Especialmente, “Subscriber: Webhook” e “Publisher: Polling” sendo configurados aqui.

cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br

A API é publicada para gerar uma API orientada a eventos.

Gerenciamento de API baseado em eventos - captura de dados de mudança 7

Streams v2 é chamado para gerar os objetos corretos para a API orientada a eventos e uma nova entrada é incluída no Catálogo de API.

Gerenciamento de API baseado em eventos - captura de dados de mudança 8

Agora, temos esta nova API Petstore_async! Foi até concedido automaticamente à organização certa!

Vamos ver como será usado.

Fase de desenvolvedor de aplicativos

Vamos trocar de usuário e mostrar o ponto de vista do desenvolvedor de aplicativos.

O desenvolvedor de aplicativos se conecta ao portal API.

Gerenciamento de API baseado em eventos - captura de dados de mudança 9

Com a capacidade de personalização do Portal API, é possível criar um catálogo dedicado para todas as APIs orientadas a eventos, com base na filtragem de tags. Dessa forma, é mais simples encontrar APIs orientadas a eventos.

Leia Também  A modernização herdada pode fornecer uma vantagem competitiva para as empresas

Esta API de assinatura de webhook é como qualquer outra: documentação, assinatura, teste, monitoramento …

Vamos ver a documentação da API em detalhes:

Gerenciamento de API baseado em eventos - captura de dados de mudança 10

Esta API é muito simples de consumir. As opções foram definidas para que dois métodos da API base estejam disponíveis para o webhook: getInventory, findPetsbyStatus.

Para cada método de API base, existem três métodos nesta assinatura: criar, ler, excluir.

Portanto, a próxima etapa é assinar o aplicativo. Isso pode ser feito com qualquer testador REST, mas também diretamente do Portal API com o Try-It. Nesse caso, a chave API é necessária.

Gerenciamento de API baseado em eventos - captura de dados de mudança 11

E feito!

Fase de tempo de execução

Durante o tempo de execução, o aplicativo recebe a notificação. A melhor maneira de rastreá-lo é por meio dos recursos de monitoramento do Gerenciamento de API.

Gerenciamento de API baseado em eventos - captura de dados de mudança 12

Todas as chamadas de pesquisa são feitas pelo Streams v2 e rastreadas no APIM, uma vez que a API base está no catálogo.

Vamos mudar o filtro de monitoramento para ver nossas notificações de webhook. No momento da assinatura, uma notificação é enviada:

Gerenciamento de API baseado em eventos - captura de dados de mudança 13

Os dados enviados são com todos os animais de estimação disponíveis. Esta é a visão completa.

Gerenciamento de API baseado em eventos - captura de dados de mudança 14

Mais tarde, um consumidor adiciona um novo animal de estimação.

O que temos é apenas a notificação deste novo animal de estimação.

Gerenciamento de API baseado em eventos - captura de dados de mudança 15

Isso é ótimo! Isso é exatamente o que o aplicativo queria!

Você prefere ter todos os animais disponíveis? Depende de você, pois esse é um dos recursos e a opção configurável do Streams.

Vamos resumir

Você deseja fornecer um webhook para uma API? Isso é muito simples com o Gerenciamento de API baseado em eventos!

  • Virtualize uma API e defina opções para gerar uma API orientada a eventos.
  • Consuma a API de assinatura do webhook como qualquer outro.
  • Monitore todas as interações com recursos APIM padrão.
Leia Também  Resumo de ameaças de 19 a 26 de junho

Esse recurso pode ser muito útil para integrar uma estratégia API-First em uma arquitetura orientada a eventos.

Descubra como a Axway revelou sua nova solução orientada a eventos para transmitir APIs para sua estratégia de API.

cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br