Este guia mostra como criar uma integração funcional que extrai dados de usuários de uma API pública e os envia em formato CSV para um servidor SFTP. Ao final, você entenderá como as conexões SFTP funcionam na RWS Integration.
O que você vai construir Você criará uma integração que:
Extrai registros de usuários do JSONPlaceholder (uma API de teste gratuita)Transforma os dados para um formato mais simplesEnvia os resultados para um servidor SFTP em formato CSV
Tempo necessário: aproximadamente 5 minutos.
Pré-requisitos
Acesso a um Workspace da RWS Integration
Um navegador web
Um servidor SFTP
Passo 1: Crie a conexão de origem Conexões definem como a RWS Integration se comunica com sistemas externos. Você criará uma para a API de origem.
Na barra lateral, clique em Conexões
Clique em Nova Conexão
Configure a conexão:
Campo Valor Name JSONPlaceholder APIType APIURL https://jsonplaceholder.typicode.comBase Path /Authentication Simple
Deixe Header Parameters e Query Parameters vazios
Clique em Save
A API JSONPlaceholder não requer autenticação, então o tipo de autenticação Simple sem parâmetros adicionais funciona.
Passo 2: Crie a conexão de destino Agora crie uma Conexão para seu servidor SFTP de destino.
Clique em Nova Conexão
Configure a conexão:
Campo Valor Name SFTP ConnectionType SFTPURL sftp.example.comBase Path /uploadsPort 22Username usernameSSH Private Key private_key
Clique em Save
Passo 3: Crie a Integração Com ambas as Conexões prontas, crie a Integração que move dados entre elas.
Na barra lateral, clique em Integrações
Clique em Nova Integração
Configurações gerais Configure as propriedades básicas da integração:
Campo Valor Name Load File to SFTPVersion 1.0.0Type FullEnvironment StagingSchedule rate(1 day)
A fase de Extração recupera dados do seu sistema de origem.
Expanda a seção Extração
Configure estes campos:
Campo Valor Connection JSONPlaceholder APIMethod GETPath /users
Defina o Datapoint Path in Response como root
Defina a Paginação :
Campo Valor Pagination Type SimplePage size parameter _limitPage size value 10Initial page parameter _pageInitial page value 1Pagination end type Object
Verifique o painel Preview de Extração no lado direito — ele deve mostrar:
Status: 200 OK
Um único registro de usuário (o Datapoint) como este:
{ "id" : 1 , "name" : "Leanne Graham" , "username" : "Bret" , "email" : "Sincere@april.biz" , }
Integrações SFTP não suportam a fase de Enriquecimento.
A fase de Transformação mapeia campos de origem para o formato de destino. Para este guia, crie um mapeamento simples com três campos.
Expanda a seção Transformação
Clique em Adicionar Transformação e configure:
Tipo De Para Simple iduserIdSimple namefullNameSimple emailemailAddress
Verifique o painel Preview de Transformação — ele deve exibir:
{ "userId" : 1 , "fullName" : "Leanne Graham" , "emailAddress" : "Sincere@april.biz" }
Isso confirma que seus mapeamentos estão funcionando corretamente com dados reais da fase de Extração.
Fase de Envio A fase de Envio envia dados transformados para seu destino.
Expanda a seção Envio
Configure estes campos:
Campo Valor Connection SFTP ConnectionPath /guidesFile name users.csv
A RWS Integration criará o arquivo no diretório /guides. Se o diretório não existir, ele será criado. O único formato suportado é CSV.
Passo 4: Crie a Integração
Ative o toggle Implantação
Clique em Criar Integração
Como configuramos rate(1 day) como agendamento, a integração executará imediatamente após a criação. Depois disso, executará automaticamente a cada 24 horas.
Passo 5: Verifique os resultados Vá para seu servidor SFTP e verifique se o arquivo users.csv foi criado no diretório /guides.
Você deve ver um arquivo com esta estrutura:
userId, fullName, emailAddress 1, Leanne Graham, Sincere@april.biz 2, Ervin Howell, Shanna@melissa.tv 3, Clementine Bauch, Nathan@yesenia.net
Parabéns — você criou e executou sua primeira integração SFTP!
O que você aprendeu
Conexões SFTP armazenam configurações para servidores SFTP e podem ser reutilizadas em múltiplas IntegrationsIntegrações seguem o padrão Extração → Transformação → EnvioPainéis de Preview atualizam automaticamente conforme você configura cada fase, permitindo validar antes de executarTransformações simples mapeiam campos da origem para o destino usando notação JSONPathFormato de arquivo CSV é suportado para integrações SFTP
Próximos passos
Conexões Aprenda sobre os diferentes métodos de autenticação
Paginação Lide com paginação e respostas de API complexas
Regras de Negócio Domine transformações de campos com JavaScript
Agendamento Agende suas integrações para executar automaticamente