Hora de botar a mão na massa! Neste post, vamos explicar de maneira prática como fazer uma chamada de API para um serviço de API REST, usando a Conexão do Cliente HTTP/S. Como exemplo, vamos usar a solução Amplify Integration da Axway.
Primeiro, sempre verifique se o serviço de API REST possui um documento Open API ou documento Swagger associado a ele. Se sim, você pode usar a Conexão do Cliente OpenAPI do Amplify Integration.
Nesse teste, nossa API REST não possui, então usaremos uma Conexão do Cliente HTTP/S do Amplify Integration. Você pode visualizar a documentação técnica online para a solução aqui e, se tiver interesse, também pode se inscrever gratuitamente para um curso online de Introdução ao Amplify Integration no Axway University aqui.
Criar uma Integração
- Crie uma integração com um acionador de evento de agendamento de 60 segundos e adicione um componente de Cliente HTTP/S Get
- Expanda o painel inferior e clique em “Adicionar” ao lado de “Conexão” para adicionar uma nova Conexão do Cliente HTTP/S
- Dê um nome e descrição à Conexão (por exemplo, API da NASA)
Acesse a API da NASA em https://api.nasa.gov, revise a documentação e obtenha uma chave de API.
Clique em “Browse APIs” e veja a API APOD (Astronomy Picture of the Day).
A URL para a chamada da API é https://api.nasa.gov/planetary/apod.
Revise os parâmetros de consulta que podem ser enviados. Note que a chave da API é enviada como um parâmetro de consulta. Isso não é incomum, mas também não é a melhor prática.
Um exemplo de consulta é https://api.nasa.gov/planetary/apod?api_key=DEMO_KEY.
Agora temos as informações necessárias para configurar a Conexão do Cliente HTTP/S e usá-la em um componente Cliente HTTP/S Get para chamar a API.
Configurar a Conexão
- Defina o Protocolo como HTTPS
- Defina a versão do HTTP como HTTP/2
- Digite api.nasa.gov para URL
- Deixe a Autenticação do Cliente como Nenhum
- Defina o Certificado do Servidor como Aceitar Todos
- Clique em Atualizar e Testar
Configurar o Componente Cliente HTTP/S Get
Volte para a integração e clique no Componente Cliente HTTP/S Get e expanda o painel inferior
- Atualize o seletor de Conexão e selecione a Conexão do Cliente HTTP/S da NASA que acabamos de criar acima;
- Expanda as Propriedades da Ação HTTPSGetInput e defina o basePath como /planetary/apod;
- Clique com o botão direito em queryParams e selecione Adicionar Variável -> String -> Dentro e nomeie a variável api_key;
- Defina o valor do parâmetro de consulta api_key como sua Chave de API da NASA;
- Repita para adicionar um parâmetro de consulta chamado data. Você pode deixar a data vazia por enquanto, já que o valor padrão é hoje (conforme a Documentação da API);
- Clique em “Salvar”.
Testar a Integração
Clique no botão “Testar” para testar sua integração. Clique na etapa “Cliente HTTP/S Get” da transação na guia Monitor que abriu automaticamente quando você clicou em testar para visualizar os resultados de nossa chamada de API.
Você pode definir o valor do parâmetro de consulta de data para qualquer data anterior usando o formato AAAA-MM-DD e testar novamente para ver uma resposta diferente.
Analisar a Resposta
Se usarmos esta API em uma integração, precisaremos analisar a resposta.
Uma resposta de exemplo da API APOD da NASA é mostrada abaixo.
{
“copyright”: “Carnegie Institution for Science”,
“date”: “2023-10-06”,
“explanation”: “How big is our universe? This question, among others, was debated by two … gazed knowingly, for the first time, into a surprisingly vast cosmos.”,
“hdurl”: “https://apod.nasa.gov/apod/image/2004/HubbleVarOrig_Carnegie_2880.jpg”,
“media_type”: “image”,
“service_version”: “v1”,
“title”: “Edwin Hubble Discovers the Universe”,
“url”: “https://apod.nasa.gov/apod/image/2004/HubbleVarOrig_Carnegie_960.jpg”
}
Vamos analisar nossa resposta da seguinte forma:
- Expanda o painel inferior do componente Cliente HTTP/S Get;
- Adicione uma Variável de Extração usando o exemplo JSON acima e nomeie-a como RespostaAPOD;
- Arraste uma linha da Propriedade de Ação HTTPSGetOutput/response para a variável de extração RespostaAPOD;
- Clique em “Salvar” e teste sua integração e clique na etapa Cliente HTTP/S Get na transação para ver o conteúdo da variável RespostaAPOD.
Como mencionado acima, a maioria das APIs REST modernas terá uma autenticação mais padrão e talvez exija que determinados cabeçalhos sejam enviados em todas as chamadas. A Conexão do Cliente HTTP/S do Amplify Integration da Axway suporta a maioria dos esquemas de autenticação modernos.
Autor:
Colaborador: Leor Brenman
Arquiteto Principal de Pré-vendas II na Axway
