Integrações (iPaaS)
Conecte o seu ERP e os seus provedores ao Mercado Eletrônico sem precisar desenvolver uma integração do zero.
ℹ️ Nota
No Partner's Portal, o iPaaS é a área Integrações do menu superior, com Templates, Minhas Integrações e, em Configurações, os Conectores. As execuções das integrações ficam em Monitoramento > Execuções.
O iPaaS (Integration Platform as a Service) é a plataforma de integrações do Mercado Eletrônico. Ele fica entre o seu sistema (ERP, middleware ou provedor externo) e o ME e cuida de receber os dados, converter o formato, entregar ao destino e registrar cada passo da execução.
Em vez de adaptar o seu ERP ao formato das APIs do ME, ou o contrário, você cria uma integração a partir de um template, informa um exemplo do formato do seu sistema e revisa o mapeamento de campos sugerido por IA. A plataforma passa a fazer a conversão sempre que a integração for executada.
O que o iPaaS resolve
- Menos desenvolvimento: o seu sistema continua enviando e recebendo o JSON no formato que já conhece. A conversão para o formato do ME, ou dos dados consultados (no ME ou em um provedor REST externo) para o formato que você usa, é feita pela plataforma.
- Mapeamento assistido por IA: a IA analisa um exemplo do seu payload e sugere a ligação entre os campos, com um percentual de confiança. Você revisa, ajusta e publica.
- Validação antes de publicar: toda integração passa por um teste real antes de ser ativada.
- Rastreabilidade: cada execução fica registrada, com o status de cada etapa, os erros e o ID de Correlação que você pode informar para localizar a execução depois.
- Credencial exclusiva por integração: cada integração tem a sua própria chave de acesso, que só executa aquela integração.
Conceitos
| Conceito | O que é |
|---|---|
| Integração (fluxo) | Uma configuração publicada que executa um tipo de troca de dados, por exemplo "criar pedidos no ME a partir do meu ERP". Cada integração tem um endereço de execução (Endpoint URL) e uma credencial própria. |
| Template | O modelo usado para criar a integração. Ele define a direção, o tipo de operação e as etapas de configuração. Veja Templates. |
| Direção | Inbound (o seu sistema envia dados para o ME) ou Outbound (consulta: quem chama busca dados no ME ou em um provedor REST externo, por meio de um conector, e recebe o resultado na resposta, já no formato que vai usar). |
| Tipo de documento | O documento do ME envolvido na integração, por exemplo pedido, nota fiscal ou contrato. |
| Mapeamento | A regra que diz de onde vem cada campo do destino. É sugerido pela IA e revisado por você. Veja Mapeamento com IA. |
| Conector | O cadastro de uma API REST externa (URL, autenticação e recursos). Pode ser necessário em algum template. Veja Conectores. |
| Execução | Cada chamada feita à integração. Ela gera um registro com status, duração e o detalhe de cada etapa. Veja Execuções. |
Direções do fluxo
| Direção | Sentido | Exemplo |
|---|---|---|
| Inbound | Seu sistema → ME | O ERP envia um pedido de compra, e o iPaaS cria o pedido no ME. |
| Outbound | Consulta (ME ou provedor REST externo → resposta) | O seu sistema informa o identificador de um documento do ME e recebe, na resposta, esse documento já no formato do ERP. Ou o ME consulta um provedor REST externo, por meio de um conector, para buscar produtos. O iPaaS não envia dados ao seu sistema: o resultado volta na resposta da chamada. |
Templates disponíveis
| Template | Direção | O que faz |
|---|---|---|
| Criação de Documentos (Inbound) | Inbound | Recebe um documento do seu ERP, converte para o formato do ME e cria o documento no ME. |
| Busca de Documentos (Outbound) | Outbound | Busca um documento do ME pelo identificador e devolve o documento convertido para o formato do seu ERP. |
| Busca de Produtos | Outbound | Conecta um provedor REST de catálogo para que o ME busque produtos e ofertas em tempo real. |
Jornada resumida
- Escolha um template no Partner's Portal, em Integrações > Templates.
- Configure os parâmetros: ERP, tipo de documento e, na Busca de Produtos, o conector.
- Informe a estrutura do documento: cole um exemplo do JSON do seu sistema.
- Revise o mapeamento sugerido pela IA.
- Teste a integração com uma execução real.
- Publique. A integração fica Ativa. Na Criação de Documentos (Inbound) e na Busca de Documentos (Outbound), a tela final exibe a credencial (Chave e Secret): copie a Secret antes de sair do assistente. Na Busca de Produtos, quem chama a integração é o próprio ME, e não há credencial a copiar.
- Execute chamando a Endpoint URL da integração com um token gerado a partir dessa credencial.
- Acompanhe as execuções em Monitoramento > Execuções.