Módulo 5: Serviço Web RESTful¶

Introdução¶

Módulo 5 na Introdução ao Harmony Cloud Studio demonstra a consulta de um serviço da Web REST e a gravação da resposta em um servidor SFTP como um arquivo de texto.

Pré-requisitos¶

Esta página pressupõe que você concluiu o Módulo 1 - Banco de dados para texto, onde você configurou uma conexão com o servidor SFTP de treinamento do Jitterbit. Também requer a conclusão do Módulo 4 - SOAP Web Service, pois reaproveita diversos componentes do projeto deste módulo.

Resumo¶

Neste módulo, você consultar um serviço Web RESTful para obter informações meteorológicas com base no código postal e, em seguida, gravará esses dados no servidor SFTP de treinamento como um arquivo de texto.

A operação concluída ficará assim:

Esta operação usa este mapeamento de transformação:

1. Configure uma Conexão HTTP¶

Para este módulo, você continua trabalhando no mesmo projeto do Módulo 1 e cria uma nova conexão SOAP:

1. No mesmo projeto do Módulo 1, crie um novo workflow e nomeie-o "Módulo 5".

2. Na aba Conexões da paleta de componentes, no filtro Conectores, clique no conector HTTP:

   

3. Configure a conexão HTTP:

   • Nome do Endpoint: "Código postal – REST"
   • Base URL: Cole a base URL para este serviço: "https://trainingoptrial112860.jitterbit.net/TrainingOpsCloud/v1/REST_Service/".

4. Clique em Salvar alterações.

A conexão HTTP deve ter uma configuração semelhante a esta:

2. Configure uma Atividade HTTP¶

Em seguida, configure uma atividade associada à conexão HTTP para obter os dados do serviço da web:

1. Na aba Connections da paleta de componentes sob o filtro Endpoints, clique na conexão "Zip Code – REST" que você acabou de criar:

   

2. Arraste um tipo de atividade HTTP GET para a área de inserção de componentes na quadro de design para criar uma instância de uma atividade HTTP GET em uma nova operação.

3. Renomeie a operação para "Zip Code – REST".

4. Clique duas vezes na atividade HTTP GET dentro da operação para abrir sua configuração.

5. Configure a atividade HTTP:

   • Nome: "Detalhes do CEP"

   • Verbo HTTP: "GET"

   • Caminho: "zip"

   • Parâmetros de solicitação: Clique em Adicionar para definir um parâmetro de consultar chamado "código" com o valor do seu CEP (por exemplo, "94501"). Clique em Avançar.

   • Provide Request Schema: Como não há necessidade de fornecer um esquema de solicitação (uma solicitação GET padrão não contém um corpo), clique em Next novamente.

   • Provide Response Schema: Selecione Yes, Provide New Schema, forneça um nome de esquema de "Zip Code Detail" e cole esta estrutura de resposta JSON esperada na caixa de texto inferior:

     {
       "zip": 12345,
       "type": "",
       "primaryCity": "",
       "state": "",
       "county": "",
       "timeZone": "",
       "areaCodes": "",
       "latitude": "",
       "longitude": "",
       "country": "",
       "population": 123456
     }
     

     Clique em Avançar.

   • Esquema de dados: Revise o esquema de dados e clique em Concluído para retornar à quadro de design.

A tela final da configuração da atividade deve ser semelhante a esta:

3. Configure uma Atividade de FTP¶

Nesta etapa, você reutiliza a atividade FTP Write criada no Módulo 4:

1. Na aba Componentes do painel do projeto, expanda Endpoints > FTP Endpoints para localizar a conexão "SFTP" e a atividade de gravação "Dados do CEP" que você criou como parte do Módulo 4.
2. Arraste a atividade de gravação "Dados do CEP" para uma área de inserção à direita da atividade HTTP dentro da operação na quadro de design para reutilizá-la na operação.

4. Configurar uma Transformação¶

Em seguida, você cria uma transformação para transformar dados da origem HTTP para o destino FTP:

1. Na quadro de design, passe o mouse sobre a área entre a atividade HTTP GET e a atividade FTP Write até que uma área de inserção de componentes apareça.
2. Clique na área de inserção e selecione Nova Transformação. Uma nova transformação se abrirá para você configurar:
   • Nome da Transformação: "Código postal – Resposta REST"
   • Fonte: O esquema de origem já está fornecido (à esquerda) porque você o definiu na atividade GET.
   • Destino: Você precisa definir o esquema de destino (à direita). Clique em Define Schema e selecione Use Sample File. Configure o esquema de arquivo de exemplo:
     • Fornecer arquivo de esquema: Selecione Usar esquema salvo.
     • Esquemas salvos: Use o menu suspenso para selecionar o esquema "Dados de CEP" delimitado por tabulações que você definiu como parte do Módulo 4. Clique em Concluir.
3. Na parte superior direita do esquema de destino, clique em Automap Exact Matches. Em seguida, clique em Retornar ao Workflow.

O mapeamento de transformação deve ser semelhante a este:

5. Implantar e Executar a Operação¶

Por fim, com todas as etapas da operação configuradas, você implantar e executa a operação:

1. No canto superior direito da operação, clique no ícone do menu de ações e no menu clique em Deploy and Run. O status da operação é exibido no canto inferior esquerdo da operação.
2. Depois que a operação for bem-sucedida, faça login no servidor SFTP de treinamento do Jitterbit e visualize o arquivo que você gerou.