O que você vai construir
Você vai configurar a extração de uma integração que lê as admissões do último mês ao vivo de um sistema de folha SOAP, recebendo-as como registros JSON prontos para transformações, filtros e envios como qualquer outra fonte de API. Tempo necessário: aproximadamente 10 minutos.Pré-requisitos
- Acesso a um RWS Integration Workspace
- RWS Connect Live habilitado para sua conta, com a
x-api-keyfornecida pela RWS - As credenciais do seu sistema armazenadas com a RWS, e o endereço dele aprovado para sua conta (para configurar, envie um email para connect@rwsintegration.com)
- A operação SOAP que você quer chamar: endereço, action e XML de requisição (da documentação do seu sistema, ou pergunte à RWS)
https://folha.exemplo.com.br. Substitua os endereços, o XML e as credenciais pelos do seu sistema.
Passo 1: Crie a Conexão
Você só faz isso uma vez. A mesma Conexão serve para todas as integrações Live que você vier a construir — qual sistema e qual operação chamar são escolhidos depois, por integração.- Na barra lateral, clique em Connections
- Clique em New Connection
- Configure a conexão:
- Clique em Save
Passo 2: Configure a Extração
Tudo sobre a chamada SOAP viaja como query parameters, então fica tudo em um lugar só: a configuração de extração da sua integração.- Na sua integração, expanda a seção Extract
- Configure estes campos:
- Adicione os Query Params que descrevem a chamada. Primeiro, qual operação chamar:
O
x_soap_auth_header é o bloco de autenticação que o seu sistema espera, exatamente como aparece em uma requisição SOAP que funciona — com uma diferença: as credenciais são referenciadas por nome, nunca escritas:
Nomes como
{FOLHA_USUARIO} são preenchidos pela RWS no momento da chamada, a partir das credenciais armazenadas com segurança para a sua conta — as mesmas que seus pipelines do Connect usam. Senhas nunca aparecem na sua configuração e nunca viajam na requisição.x_body_template é o XML de requisição da operação, com {slots} onde os valores mudam a cada execução:
- Agora adicione os parâmetros que preenchem esses slots — query params comuns, com os mesmos nomes:
O
x_record_tag nomeia o elemento XML que vira seus registros: cada <ContratoDeTrabalho> da resposta se transforma em um item JSON. Parâmetros dinâmicos como today.subtract(30.day) funcionam aqui como em qualquer lugar.
-
Defina o Datapoint Path in Response como
items - Configure a Paginação:
O parâmetro
pagina preenche o slot {pagina} do template, e a extração para sozinha na primeira página vazia.
Passo 3: Confira o preview
O painel Extract Preview deve mostrar status200 OK e seus registros como JSON limpo — nomes em snake_case, aninhados do jeito que o seu sistema estrutura, todos os valores como texto:
Guardas de qualidade opcionais
Quatro parâmetros extras protegem a chamada contra surpresas na resposta. Todos opcionais, todos de uma linha:Live ou tabelas?
Os dois compartilham a mesma api key e se complementam: muitos clientes alimentam dashboards com as tabelas e rodam o monitoramento no Live.
Quando algo dá errado
O Live falha com clareza e diz o porquê. Uma chave não habilitada recebe um403 claro pedindo para falar com a RWS. Uma chamada mal configurada recebe um 400 nomeando exatamente o parâmetro a corrigir. E se o seu sistema retornar um erro — mesmo um disfarçado dentro de uma resposta normal — você recebe um erro claro, nunca um sucesso vazio silencioso.
O que você aprendeu
- Uma Conexão, todas as integrações: sistema, operação e XML são query parameters, então uma única conexão
RWS Connect Liveserve para tudo - As credenciais ficam com a RWS: os templates referenciam nomes como
{FOLHA_USUARIO}; os valores são preenchidos com segurança no momento da chamada - O
x_record_tagtransforma XML em registros, entregues como JSON aninhado emsnake_casedentro deitems - A paginação simplesmente funciona: o parâmetro de página preenche um
{slot}e a extração para na primeira página vazia
Próximos passos
Monitoramento
Acompanhe suas integrações e fluxos de negócio
Parâmetros Dinâmicos
Janelas de data como “os últimos 30 dias”
RWS Connect
Seus dados legados como tabelas armazenadas e consultáveis
Enriquecimento
Complete cada registro com dados de outras APIs