Pular para o conteúdo principal

Visão Geral

O Enriquecimento busca dados adicionais para cada datapoint retornado pela fase principal de Extração. Para cada registro extraído, a RWS Integration faz uma ou mais requisições de API secundárias e anexa as respostas ao datapoint, para que o restante da integração possa combinar campos tanto da extração original quanto dos enriquecimentos. O fluxo se torna Extração → Enriquecimento → Transformação → Envio.

Quando usar

Use enriquecimento quando a extração principal retorna registros que estão sem detalhes disponíveis em um endpoint separado — por exemplo, buscar comentários de um post, itens de um pedido ou detalhes de endereço de um cliente identificados por um ID presente na lista principal.

Configuração

Cada enriquecimento é definido por:
CampoDescrição
NomeChave sob a qual a resposta é armazenada (ex.: comments)
ConexãoConexão usada para a requisição
MétodoMétodo HTTP (GET, POST, etc.)
CaminhoCaminho do endpoint, que pode incluir parâmetros como {{ parameterId }}
Parâmetros de query do enriquecimentoFornecem os valores para os parâmetros referenciados no path
Um parâmetro de query associa um valor a um nome. O path pode então referenciar esse nome como {{ name }}. O valor pode ser definido de duas formas:
TipoDescrição
FixoUm valor fixo a ser usado como parâmetro de query
Regra de NegócioUm valor calculado com uma regra de negócio em JavaScript
Um valor Fixo pode conter placeholders {{ ... }} que são interpolados a partir do datapoint da extração principal ou de outro enriquecimento — ex.: {{ id }}. Veja Parâmetros Dinâmicos para mais informações.

Referenciando outros enriquecimentos

Por padrão, todo enriquecimento é executado sobre o datapoint da extração principal. Um enriquecimento também pode depender da resposta de outro enriquecimento — útil quando uma requisição retorna um ID necessário para montar a próxima requisição. Ative Possui outro enriquecimento como dependência? e defina o Nome do enriquecimento com o nome do enriquecimento do qual ele depende. Você pode então referenciar os campos da resposta desse enriquecimento usando notação de ponto:
{{ enrichmentName.path }}
Por exemplo, se um enriquecimento chamado comments retorna os comentários de um post, um enriquecimento dependente pode usar seus campos nos valores dos parâmetros de query:
Fixed valueTo
{{ comments[0].postId }}postId
{{ comments[0].email }}commenterEmail
Enriquecimentos dependentes são executados após o enriquecimento que referenciam, de modo que seus dados estejam disponíveis quando a requisição for montada.

Continuar execução em caso de erro

Cada enriquecimento possui uma caixa de seleção Continuar execução mesmo com falha. Quando ativada, uma requisição de enriquecimento que falha (status http 4xx ou 5xx) não interrompe a integração — o datapoint continua pelas fases de Transformação e Envio sem os dados desse enriquecimento. Quando desativada (o padrão), uma requisição de enriquecimento que falha lança um erro e interrompe a integração. Ative isso quando o enriquecimento é opcional e você prefere entregar dados parciais a interromper a integração.

Acessando dados de enriquecimento

As respostas de enriquecimento são expostas em outras seções da integração sob resources, identificadas pelo nome do enriquecimento:
resources.{{ enrichmentName }}.{{ fieldPath }}
Para um enriquecimento chamado comments que retorna um array:
FromTo
resources.comments[0].emailfirstCommentEmail
resources.comments[0].bodyfirstCommentText

Relacionados

Parâmetros Dinâmicos

Interpole valores em paths, headers e corpos de requisições

Integração com múltiplas extrações

Guia passo a passo para construir uma integração com enriquecimento