YOM Docs

• Guias de integração
  • Formas de integração
    • Integração por API
    • Integração por arquivos
  • Entidades
    • Categorias
    • Centro de Distribuição
    • Comércios
    • Comodatos
    • Custo de entrega
    • Crédito
    • Documentos Fiscais
    • Limite de desconto
    • Pagamentos
    • Produtos
    • Promoções
    • Segmentos
    • Sobrescritas
    • Estoque
    • Supervisores
    • Transações
    • Vendedores
  • Webhooks
    • Requisitos técnicos
    • Webhooks do cliente para a YOM
      • Modificação de pedidos
      • Carga em massa de estoque
      • Modificação em massa de pedidos
    • Webhooks da YOM para o cliente
      • Pedidos
      • Pagamentos
      • Pedido mínimo
      • Preço de entrega
      • Devoluções
      • Comodatos
      • Criação de comércios
  • Changelog
  • API de Extração de Recomendações
    • Autenticação
    • Recomendações
    • Boas práticas
• Configurações

Guias de integração

<aside> 🆕

Versão → 2.0.0

</aside>

Para começar a utilizar as soluções que a Yom oferece, é necessário integrar os dados da sua empresa de forma regular. Isso inclui sincronizar as informações de seus Clientes, Produtos, Pedidos, Estoque, entre outros.

🔁 Fluxos

Para funcionar com a YOM é necessário desenvolver integrações em duas direções: Carga de dados e Injeção de dados.

<aside> ➡️

Carga de dados

</aside>

<aside> ⬅️

Injeção de dados

</aside>

Cada empresa tem diferentes necessidades e capacidades técnicas. Por isso, oferecemos vários métodos distintos de integração para facilitar a transferência de dados entre os seus sistemas e os nossos. Eles estão documentados nas seções a seguir:

<aside> ➡️

Carga de dados

<aside> 📂

Arquivos

</aside>

</aside>

<aside> ⬅️

</aside>

A seguir explicamos os casos de uso de cada método.

➡️ Carga de dados

📂 Integração por Transferência de Arquivos (SFTP)

Descrição → Este método foi projetado para empresas que não possuem uma capacidade de desenvolvimento técnico significativa, mas que têm relatórios em forma de arquivos ou a capacidade de gerá-los periodicamente. Você deposita seus documentos de comércios, produtos e pedidos em um servidor SFTP designado. Nosso sistema consultará esses arquivos diariamente, processando e atualizando as informações em nossos sistemas.

Ideal para →

• Empresas com infraestrutura SFTP estabelecida.
• Organizações que lidam com grandes volumes de dados em lotes.
• Aquelas que preferem uma solução simples e eficaz para a transferência de dados sem necessidade de desenvolvimento técnico avançado.

📤 Integração por API Programada

Descrição → Esta abordagem é ideal para empresas que têm a capacidade de desenvolvimento técnico para disponibilizar seus dados por meio de endpoints de API, mas que não podem executar as ações de carga em tempo real. Neste método, nós realizamos solicitações HTTP GET aos endpoints que você nos fornece, obtendo os dados necessários com a regularidade que definirmos juntos.

Ideal para →