Portfólio de Integrações

Coleção de documentos de requisitos de produto para as integrações da illimitar

Integração Bancária via Arquivos OFX/CSV

Visão Geral

A integração bancária no sistema ILLI, por meio da importação de arquivos nos formatos OFX ou CSV, tem como objetivo automatizar a conciliação financeira entre os registros internos (contas a pagar e receber) e os lançamentos bancários efetivos.

Com essa funcionalidade, os usuários podem importar os extratos bancários diretamente para o sistema, permitindo que o ILLI identifique automaticamente os títulos quitados e associe-os aos respectivos lançamentos financeiros.

Com a integração, é possível:

 

 
Objetivo do Produto

Desenvolver uma solução de conciliação bancária eficaz, baseada em arquivos OFX ou CSV, que permita aos usuários importar extratos bancários e realizar a baixa automática de títulos, otimizando o processo de controle financeiro e garantindo mais agilidade e segurança na gestão de contas.

 

 
Público-Alvo

 

 
Apresentação Comercial

Conciliação bancária automatizada com importação de arquivos OFX e CSV.

Elimine processos manuais e reduza o retrabalho com uma solução prática e eficiente integrada ao sistema ILLI.

Principais benefícios:

 

 

Funcionalidades Principais

1. Importação de Arquivos Bancários

 

 
2. Baixa Automática de Títulos

 

 

3. Associação Manual de Títulos

Caso o sistema não reconheça automaticamente o título, o usuário pode:

⚠️ Situações comuns em que pode ocorrer falha na detecção:

 

 

4. Visualização e Edição

 

 

5. Compatibilidade e Requisitos Técnicos

 

 

Considerações Finais

Diretrizes de documentacao


Diretrizes de documentacao

Diretrizes para Manuais de Implantação

Público-alvo:

 
Objetivo

 

 
Estrutura Recomendada

  1. Capa + Título

    • Exemplo: Manual de Implantação – Integração ILLI + F360

    • Adicione versão e data se necessário

  2. 📍 Visão Geral

    • Descreva o que a integração faz

    • Liste os principais benefícios (automatização, economia, visibilidade)

  3. ✅ Pré-requisitos

    • Listar recursos, permissões, bibliotecas e credenciais necessárias

    • Ex: API Key, CNPJ cadastrado, biblioteca instalada

  4. 🧩 Estrutura da Integração

    • Se possível, inclua um diagrama simples (push/pull, sincronização)

    • Mostre quem envia e quem recebe

  5. ⚙️ Etapas de Instalação e Configuração

    • Passo a passo com numeração clara

    • Destaque botões, telas e URLs quando necessário

  6. 🧾 Dados Sincronizados

    • Tabela simples com os tipos de dados envolvidos

    • Ex: valor bruto, data da venda, bandeira, taxa

  7. 🔁 Fluxo de Operação

    • Descrever a rotina de funcionamento: o que acontece e quando

    • Ex: “a cada hora o sistema busca novas vendas”

  8. 🧠 Dicas e Boas Práticas

    • Ex: "Não envie o mesmo cupom duas vezes", "Verifique o status na plataforma X"

  9. 👥 Equipe Técnica Envolvida

    • Nome + papel de cada responsável

  10. 📎 Links Úteis

    • Documentação técnica, APIs, apresentações comerciais

 

 

Estilo e Linguagem
Diretrizes de documentacao

Diretrizes para Manuais Técnicos de Desenvolvimento

 Público-alvo:

 
Objetivo

 
Estrutura Recomendada

  1. Capa + Título

    • Exemplo: Manual Técnico – Integração ILLI + Equals (API REST)

    • Incluir versão e data

  2. 🧩 Visão Técnica Geral

    • Explicação rápida da arquitetura

    • Ex: "A integração segue modelo pull, onde a plataforma X consome dados da API Ilimitar."

  3. 🔐 Autenticação

    • Descrever método (API Key, OAuth, JWT etc.)

    • Exemplos de cabeçalhos HTTP

  4. 🌐 Endpoints Principais

    • Listagem com:

      • Método HTTP (GET, POST)

      • URL

      • Parâmetros de query e body

      • Headers exigidos

  5. 📤 Exemplos de Requisição e Resposta

    • Com JSON indentado

    • Diferenciar campos obrigatórios e opcionais

  6. 🧠 Regras de Negócio

    • Validações

    • Limites de envio

    • Comportamento esperado

    • Frequência de chamadas

  7. 📊 Tratamento de Erros

    • Códigos HTTP e explicações

    • Campos como traceId, mensagens de fallback

  8. 🔄 Frequência e Agendamento

    • Se for por consulta periódica, detalhar intervalos e comportamento

    • Se for push (webhook), descrever assinatura e retorno esperado

  9. 🔧 Controle de Acesso e Revogação

    • Como ativar e revogar API Keys, ou desabilitar integrações

  10. 📎 Referências

Estilo e Linguagem

Equals

Equals

Manual de Implantação – Integração ILLI + Equals (Conciliação de Recebíveis)

Visão Geral

A integração entre o PDV ILLI e a plataforma Equals (via ECOS) tem como objetivo centralizar e automatizar a conciliação de vendas realizadas com cartão, facilitando o controle de recebimentos e a identificação de taxas incorretas ou valores divergentes.

Duas formas de integração são possíveis:

1. Pré-requisitos para Implantação

Manual

Automatizada

2. Formas de Integração
Manual (via CSV)

Vantagens:
✔️ Rápida de implantar
❌ Necessita de ações manuais recorrentes

Automatizada (via API Ilimitar)

Vantagens:
✔️ Tempo real ou próximo
✔️ Sem ação manual
❌ Requer autenticação e biblioteca instalada

3. Autenticação e Controle de Acesso

Exemplo de usuário configurado:
Usuário: Icor
Chave: XXXXXXXXXXXXXXXXXXXXX

4. Dados Enviados / Sincronizados

A Equals (ECOS) coleta os seguintes dados via API ou CSV:

Informação Detalhes
Valor bruto da venda Inclui taxas
Forma de pagamento Crédito, débito, Pix etc.
Número do comprovante NSU da venda
Data/hora da transação Timestamp
Dados do cliente Nome e CPF (quando disponível)
Taxas e bandeiras aplicadas Inclui taxa por parcela, antecipação etc.

 

5. Funcionalidades da Equals 

6. Regras Técnicas para Integração Automatizada
Parâmetro Tipo Observação
CNPJ String Deve ser da loja a ser conciliada
DataEmissao Date Usado para filtrar as vendas
Page Integer Paginação de resultados
FormaPagamento String Apenas vendas com cartão são consultadas
Intervalo Horário Requisições a cada 5 ou 60 min

7. Instalação da Integração Automatizada

8. Aspectos Comerciais
Equals

Manual Técnico – Integração ILLI + Equals (via API ECOS)

Visão Técnica Geral

A integração permite que a plataforma ECOS (Equals) consulte o sistema ILLI para obter dados de vendas por cartão, com objetivo de realizar conciliação automática entre:

A integração ocorre via API REST JSON e segue o modelo de pull: o ECOS consulta o Ilimitar com base em um CNPJ autorizado.

Arquitetura da Integração
[EQUALS] <--pull-- [ILLI API REST]
       |
  Exibe conciliação por:
  - Loja
  - Bandeira
  - Comprovante
  - Taxas

Autenticação

Exemplo de headers:

GET /api/v1/vendas?cnpj=12345678000100&data=2025-06-01&page=1
Host: api.illimitar.com.br
Authorization: Bearer <API_KEY>
Content-Type: application/json

Para revogar o acesso:

Requisições (EQUALS → Ilimitar)

Endpoint principal 

GET /api/v1/vendas
Parâmetros disponíveis:
Parâmetro Tipo Descrição
cnpj string CNPJ da loja que será consultada
data string Data da venda (formato: yyyy-MM-dd)
page int Página de resultados
formaPagamento string Filtro opcional (ex: “Cartão de Crédito”)


Exemplo de resposta (JSON)

{
  "total": 2,
  "pagina": 1,
  "vendas": [
    {
      "numeroComprovante": "NSU00123",
      "valorBruto": 120.00,
      "dataHora": "2025-06-01T14:00:00",
      "formaPagamento": "Cartão Crédito",
      "parcelas": 2,
      "bandeira": "Mastercard",
      "taxa": 4.25,
      "valorLiquido": 114.90,
      "cliente": {
        "nome": "João Silva",
        "cpf": "12345678900"
      }
    }
  ]
}

Frequência de consulta

Regras de negócio

Tratamento de Erros
Código Motivo
401 API Key inválida ou expirada
403 CNPJ não autorizado
404 Nenhuma venda encontrada
500 Erro interno no Ilimitar

Considerações Técnicas

Equals

Overview Integração Equals

Visão Geral

A integração entre o PDV ILLI e a plataforma Equals tem como objetivo principal automatizar e centralizar a conciliação de vendas, proporcionando aos usuários uma visão clara e completa de seus recebimentos. Através da sincronização de dados em tempo real, a integração facilitará a identificação de divergências nas taxas aplicadas e nos valores recebidos, agilizando a gestão financeira e otimizando o controle sobre as vendas realizadas.

A integração permitirá:

Objetivo do Produto

Desenvolver uma solução de integração completa e eficiente entre o PDV ILLI e a plataforma Equals, que automatize a conciliação de vendas, simplifique a gestão financeira e promova uma experiência mais prática e organizada para os usuários.

Público-Alvo

 

 

Apresentação Comercial
Acesse a apresentação completa aqui
Documentações de APIs
Funcionalidades Principais
Importação de Dados de Vendas
Conciliação Automática
Integração com Módulos Equals
Instalação e Configuração
  1. Baixe a biblioteca de integração: link para download
  2. Adicione a biblioteca na base do cliente.
  3. Certifique-se da compatibilidade com APIs REST e JSON.
Obtenção e Fornecimento da API Key
  1. Gere a API Key do ILLI.
  2. Forneça a API Key ao cliente.
Configuração no Portal Equals
  1. Acesse o portal Equals.
  2. Insira a API Key para autenticação.
Equipe Envolvida

F360

F360

Manual de Implantação – Integração ILLI + F360 Finanças (via Webhook)

Visão Geral

A integração entre o sistema ILLI e o F360 Finanças permite automatizar o envio de dados financeiros, centralizando informações como:

 
1. Pré-Requisitos para Início

Antes de configurar a integração:

2. Endpoints Padrão

Formato da URL:

https://webhook.f360.com.br/{identificador-unico-do-servico}/{servico-consumido}

 
3. Envio de Cupons Fiscais

Use o endpoint f360-cupom-fiscal para enviar registros de venda.

Requisição:

Exemplo de JSON simplificado:

{
  "NomeSistema": "ILLI",
  "Values": [
    {
      "NumeroCupom": "100001",
      "CNPJEmitente": "12345678000100",
      "Cliente": {
        "Nome": "Maria Oliveira",
        "Cpf": "12345678900"
      },
      "MeioPagamento": [
        {
          "FormaPagamento": "PIX",
          "Valor": 120.50,
          "QtdParcelas": "1",
          "Vencimento": "2025-06-01T14:30:00"
        }
      ],
      "Data": "2025-06-01T14:30:00"
    }
  ]
}

Campos obrigatórios:

Observações:

4. Envio de Títulos (Contas a Pagar e Receber)

Use o endpoint f360-{id}-titulos para enviar registros financeiros.

Requisição:

Exemplo de JSON simplificado:

{
  "titulos": [
    {
      "cnpj": "12345678000100",
      "tipoTitulo": "receber",
      "numeroTitulo": "A00123",
      "clienteFornecedor": "João da Silva",
      "detalhesClienteFornecedor": {
        "nome": "João da Silva",
        "cpfCnpj": "12345678900"
      },
      "emissao": "2025-06-01",
      "valor": 200.00,
      "tipoDocumento": "boleto",
      "contaBancaria": "Conta Banco XYZ",
      "meioPagamento": "boleto",
      "parcelas": [
        {
          "vencimento": "2025-06-30",
          "valor": 200.00,
          "numeroParcela": 1
        }
      ],
      "rateio": [
        {
          "competencia": "06-2025",
          "centroDeCusto": "Operacional",
          "planoDeContas": "Receitas",
          "numeroParcela": 1,
          "valor": 200.00
        }
      ]
    }
  ]
}

Campos obrigatórios:

cnpj, tipoTitulo, numeroTitulo, clienteFornecedor, emissao, valor, tipoDocumento, contaBancaria, meioPagamento, parcelas, rateio

5. Boas Práticas


6. Respostas da API
Tipo de Retorno Código Significado
Sucesso 200 Dados recebidos com sucesso
Erro 500 Erro no processamento. Verifique os dados enviados

Exemplo de resposta com sucesso:

{
  "rastreioId": "5737a24e-8eef-4090-9c8d-6c168af2c8a4"
}

7. Benefícios da Integração
F360

Manual Técnico – Integração ILLI + F360 (Webhooks)

Estrutura Geral

 Autenticação

Não há autenticação via token no Webhook. A segurança e a identificação são feitas via identificador-unico-do-servico gerado pelo F360 e atribuído a cada cliente.

Endpoints

Formato padrão das URLs:

https://webhook.f360.com.br/{identificador-unico-do-servico}/{servico-consumido}

Envio de Cupons Fiscais

POST /{identificador}/f360-cupom-fiscal

Regras Técnicas

📤 Payload (exemplo):
{
  "NomeSistema": "ILLI",
  "Values": [
    {
      "NumeroCupom": "001234",
      "CNPJEmitente": "12345678000100",
      "Cliente": {
        "Nome": "João Silva",
        "Cpf": "12345678900"
      },
      "MeioPagamento": [
        {
          "FormaPagamento": "Cartao Crédito",
          "Valor": 100.00,
          "Autorizacao": "ABC123",
          "NSU": "999999",
          "QtdParcelas": "2",
          "Parcelas": [
            {
              "DataDeApresentacao": "2025-06-01",
              "Valor": 50.00,
              "NumeroDaParcela": 1,
              "Vencimento": "2025-07-01"
            },
            {
              "DataDeApresentacao": "2025-06-01",
              "Valor": 50.00,
              "NumeroDaParcela": 2,
              "Vencimento": "2025-08-01"
            }
          ]
        }
      ],
      "Data": "2025-06-01T14:00:00",
      "VendaCancelada": false,
      "ValorFrete": 10.00
    }
  ]
}
 Campos obrigatórios

 

Envio de Títulos (Contas a Pagar e Receber)

POST /{identificador}/f360-{id}-titulos

Regras Técnicas
📤 Payload (exemplo):
{
  "titulos": [
    {
      "cnpj": "12345678000100",
      "tipoTitulo": "receber",
      "numeroTitulo": "ABC001",
      "clienteFornecedor": "Empresa XYZ",
      "detalhesClienteFornecedor": {
        "nome": "Empresa XYZ",
        "cpfCnpj": "12345678000100"
      },
      "emissao": "2025-06-01",
      "valor": 300.00,
      "tipoDocumento": "boleto",
      "contaBancaria": "Conta Itaú",
      "meioPagamento": "boleto",
      "parcelas": [
        {
          "vencimento": "2025-06-30",
          "valor": 300.00,
          "numeroParcela": 1
        }
      ],
      "rateio": [
        {
          "competencia": "06-2025",
          "centroDeCusto": "Administrativo",
          "planoDeContas": "Serviços",
          "numeroParcela": 1,
          "valor": 300.00
        }
      ]
    }
  ]
}
Campos obrigatórios

 

Respostas da API
HTTP Code Significado Payload
200 Sucesso {"rastreioId": "<UUID>"}
500 Erro

JSON com traceId e status


Observações Técnicas
F360

Overview Integração F360

Visão Geral

A integração entre o sistema ILLI e a plataforma F360 tem como objetivo centralizar e simplificar a conciliação financeira, abrangendo títulos de contas a pagar, contas a receber e vendas realizadas no ILLI. Essa integração automatiza o envio de dados financeiros, proporcionando maior visibilidade, controle e agilidade na gestão das operações.

Com a integração, os usuários poderão:

Objetivo do Produto

Desenvolver uma solução de integração robusta e eficiente entre o sistema ILLI e a plataforma F360, que automatize a conciliação financeira e o envio de informações de vendas, contas a pagar e contas a receber, proporcionando aos usuários maior controle, visibilidade e agilidade na gestão de suas operações.

Público-Alvo

Apresentação Comercial
Acesse a apresentação

Descrição:

Acesse a apresentação completa aqui: https://gamma.app/docs/OK-Gestao-Financeira-Completa-com-Illi-x-F360--k5vhtm0md5hk6pk

Funcionalidades Principais
1. Importação de Dados Financeiros e de Vendas
2. Conciliação Automática
Equipe Envolvida

Documentação da API F360

Altervision

Altervision

Visual geral : Integração Altervision

Visão Geral

A integração entre os sistemas AlterVision, iSnapp e Linx visa automatizar e otimizar o monitoramento do fluxo de clientes em lojas físicas, proporcionando aos usuários informações precisas e atualizadas em tempo real para análise e tomada de decisão.

Objetivo do Produto

Desenvolver uma solução de integração que centralize a gestão do fluxo de dados entre os sistemas AlterVision, iSnapp e Linx, facilitando o monitoramento do fluxo de clientes, a análise de dados e a otimização de processos.

Público-Alvo

Apresentação Comercial

Apresentação comercial

Documentações de APIs

Documentação da integração

Funcionalidades Principais

Integração com o iSnapp

Autenticação Segura

Consulta de Dados
Monitoramento de Fluxo de Clientes
Relatórios e Análises
API para Análise de Dados
Equipe Envolvida
Altervision

Manual de Implantação – Integração AlterVision + Ilimitar

Visão Geral

A integração entre a AlterVision e o sistema Ilimitar (via iSnapp) foi desenvolvida para automatizar o monitoramento de fluxo de clientes em lojas físicas, relacionar essas informações com as vendas e calcular, em tempo real, a taxa de conversão por loja.

Essa integração permite decisões mais rápidas e inteligentes, com foco em desempenho comercial, comportamento de consumo e efetividade das lojas físicas.

Objetivo do Produto

Desenvolver uma solução de integração que centralize o fluxo de dados de entrada e saída de clientes, combinando com os dados de vendas do sistema Ilimitar para oferecer análises completas via painel da AlterVision.

Público-Alvo

Pré-Requisitos

  1. Instalação da Biblioteca supademo

    • Utilizada pela AlterVision para acessar a API da Ilimitar.

    • Deve ser instalada no ambiente do cliente (já em uso em clientes como Oscar).

  2. Criação de usuário com permissão de “Gestor” no Ilimitar

    • Necessário para autenticação nas chamadas da API de vendas.

  3. Envio de credenciais à AlterVision

    • Usuário e senha de acesso Ilimitar (ou token) para consumo seguro da API.

  4. Acesso à internet liberado para chamadas HTTPS entre AlterVision ↔ Ilimitar]

 Estrutura da Integração

[Câmeras AlterVision] ---> [API iSnapp/Ilimitar] ---> [Painel AlterVision]
      (conta entradas/saídas)         (consulta vendas)       (taxa de conversão)

Etapas de Instalação
Boas Práticas

Fluxo de Operação

Altervision

Manual Técnico – Integração AlterVision + Ilimitar (via API + Biblioteca)

Visão Técnica Geral

A AlterVision realiza a contagem de fluxo de pessoas (entradas e saídas) por meio de câmeras instaladas nas lojas. Esses dados são cruzados com os dados de vendas por loja e período, obtidos via API da Ilimitar, para gerar a taxa de conversão, que é exibida no painel da AlterVision.

A integração é baseada em:

Autenticação

A API da Ilimitar exige autenticação via usuário e senha com permissão de “Gestor”.

Formato da requisição:

POST /api/auth/login
Content-Type: application/json

{
  "usuario": "altervision.api",
  "senha": "********"
}

Resposta esperada:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5..."
}

Esse token será usado no header das próximas requisições:

Authorization: Bearer <token>

Instalação da Biblioteca

A biblioteca supademo é responsável por habilitar a comunicação com a API do Ilimitar de forma estruturada.

Requisitos:

Instalação:

pip install supademo

Inicialização no código:

from supademo import IlimitarAPI

api = IlimitarAPI(usuario='altervision.api', senha='*******')
vendas = api.obter_vendas(cnpj='12345678000100', data='2025-06-05')


 Endpoint Principal
GET /api/v1/vendas

Consulta de vendas realizadas por loja e data.

Parâmetros obrigatórios:

Parâmetro Tipo Descrição
cnpj string CNPJ da loja
data string Data de vendas (YYYY-MM-DD)
paginacao int Número da página (default 1)

Exemplo de requisição:

GET /api/v1/vendas?cnpj=12345678000100&data=2025-06-05
Authorization: Bearer <token>
Content-Type: application/json

Resposta esperada:

[
  {
    "numeroComprovante": "A001",
    "valorBruto": 150.00,
    "dataHora": "2025-06-05T10:00:00",
    "formaPagamento": "Cartão",
    "bandeira": "Visa",
    "parcelas": 2
  }
]

Frequência e Sincronização

taxa_conversao = vendas_realizadas / pessoas_que_entraram

Retorno e Exibição

Todos os dados são utilizados internamente pela AlterVision para alimentar:


Regras Técnicas
Regra Detalhe
API requer autenticação com token Sessão válida por X horas (confirmar com suporte Ilimitar)
Loja deve estar com CNPJ corretamente cadastrado Senão a consulta retorna 403 ou 404
Biblioteca deve ser instalada no ambiente Deve estar no mesmo servidor onde a integração será executada
Somente vendas consolidadas Pré-vendas ou vendas abertas não são retornadas
Intervalo sugerido para leitura 5 em 5 minutos para lojas com alto fluxo; 15 minutos para lojas menores


Tratamento de Erros
Código Descrição Ação recomendada
401 Token inválido ou expirado Reautenticar
403 Usuário sem permissão suficiente Verificar permissão “Gestor”
404 Loja ou vendas não encontradas Verificar CNPJ e data
500 Erro interno na API Ilimitar Retry com backoff exponencial

 

 


Vtex

Vtex

Integração VTEX

Visão Geral

A integração entre os sistemas VTEX, Illi e iSnapp tem como objetivo automatizar e otimizar a gestão de produtos e pedidos, garantindo uma sincronização eficiente de informações entre o ERP Illi e a plataforma de e-commerce VTEX.

Objetivo do Produto

Desenvolver uma solução de integração que facilite a troca de informações entre o Illi ERP e a VTEX, proporcionando uma experiência de gestão mais fluida e automatizada, otimizando o processamento de pedidos e a consulta de produtos.

Público-Alvo
 

 

Apresentação Comercial

Acessa a apresentação

Documentação de APIs

Documentação de API

Funcionalidades Principais

 

 

Integração com o iSnapp
Autenticação Segura
Consulta de Produtos
Registro de Pedidos
Consulta de CEP
Consulta e Cadastro de Vendedores
Relatórios e Análises
Equipe Envolvida

Open Cashback


Open Cashback

Manual de Implantação: Integração com Open Cashback

O Open Cashback é um sistema de CRM parceiro, focado na fidelização de clientes através de uma carteira virtual para futuras compras. Com esta integração, você poderá oferecer os benefícios do cashback diretamente em seu fluxo de venda no Ilimitar.

 

 

1. Como Funciona a Integração?

A comunicação entre o Ilimitar e o Open Cashback é realizada por meio de duas bibliotecas que devem ser instaladas em seu sistema:

Observação Importante: As promoções e regras de cashback são configuradas na plataforma Open Cashback e operam de forma independente do motor de promoções do Ilimitar. A gestão do cashback ocorre via integração, sem a necessidade de acessar o painel do Open Cashback diretamente.

 

 

 

 

2. Passo a Passo da Configuração no Ilimitar

Vamos aos passos para ativar a integração no seu sistema.

 

 

 

3. Fluxo de Venda no Ilimitar

Com a integração ativa, veja como o processo funcionará no seu dia a dia:

 

Open Cashback

Visão Geral da Integração: illimitar e Open Cashback

1. O que é a Integração?

A integração conecta o seu sistema de gestão Ilimitar à plataforma de fidelização Open Cashback. O objetivo principal é oferecer um programa de CRM para reter clientes, onde eles recebem uma moeda virtual (cashback) para usar em compras futuras na mesma loja.

2. Principais Vantagens

3. Como Funciona na Prática?

O processo foi desenhado para ser simples tanto para o lojista quanto para o cliente final.

Para o Cliente Final:

GSI

GSI

Visão Geral da Integração: illimitar e GSI

1. O que é a GS1 e o Código EAN?

A GS1 é a única empresa autorizada no Brasil a gerar os códigos EAN (ou GTIN), aquela sequência de 13 dígitos que fica abaixo do código de barras e serve como uma identidade única para cada produto no mercado.

Normalmente, quem precisa cadastrar um produto são os fabricantes. Se a sua empresa fabrica os próprios produtos, ela precisará registrá-los na GS1 para comercializá-los.

2. Como funciona a Integração Automática?

Para facilitar sua vida, nosso sistema pode se comunicar diretamente com a GS1. Desenvolvemos uma solução que automatiza o envio das informações dos seus produtos. Veja como funciona:

2.1. Obtendo suas Credenciais

Antes de tudo, você precisa ter um usuário e senha para acessar o portal da GS1.

  1. Acesse o portal GS1 Brasil.
  2. Faça o login com seu usuário e senha.
  3. No menu, vá para Minha Conta e depois em APPs.
  4. Nesta seção, você encontrará as credenciais necessárias para a integração.

2.2. O Fluxo da Automação

Nossa integração funciona como um agendador de tarefas que roda de tempos em tempos (por exemplo, de uma em uma hora) para verificar se há novos produtos a serem enviados.

O processo segue os seguintes passos:

  1. Início: O agendador de tarefas inicia o processo.
  2. Consulta de Produtos: O sistema busca por produtos que precisam de um código EAN. Essa busca pode ser configurada para selecionar produtos por tipo, categoria ou grupo.
  3. Envio para a GS1: Se encontrar produtos, o sistema os envia para a GS1 através da nossa API de integração.
  4. Recebimento do Código EAN: A GS1 processa as informações e retorna o Código EAN para cada produto.
  5. Atualização no Sistema: Nosso sistema salva automaticamente o código EAN recebido no cadastro do produto.
  6. Fim: O processo é finalizado.

3. Como Cadastrar um Produto Manualmente na GS1

Caso prefira, você também pode cadastrar seus produtos diretamente no site da GS1.

4. Lidando com Erros no Envio

Às vezes, a GS1 pode retornar erros caso alguma informação do produto esteja incorreta. Os erros mais comuns são:

Quando um erro ocorre, nosso sistema registra o motivo da falha. É importante que a sua equipe fique de olho nesses retornos para corrigir o cadastro do produto e enviá-lo novamente para a fila de processamento.

Nota: Recomendamos configurar o envio de um e-mail de alerta para a equipe responsável sempre que um erro for detectado. Assim, eles podem acessar o nosso sistema, verificar a fila de processos, identificar o erro e tomar a ação necessária.

GSI

Manual de Implantação: Integração com GSI

Olá! Este guia foi criado para te orientar no processo de implantação da integração com a GS1. O objetivo é permitir que seu sistema se comunique de forma automática com a GS1 para gerar os Códigos EAN (GTIN-13) dos seus produtos, economizando tempo e evitando erros manuais.

 
1. O que você precisa antes de começar (Pré-requisitos)

Para que a integração funcione perfeitamente, garanta que você já tenha:

 
2. Configurando a Integração no Sistema

Agora, vamos configurar a ponte entre o nosso sistema e a GS1.

Passo 1: Inserindo suas Credenciais da GS1

  1. Primeiro, você precisa pegar suas credenciais no portal da GS1:
    • Acesse o site da GS1 Brasil e faça o login.
    • Navegue até o menu Minha Conta e depois clique em APPs.
    • Copie as suas credenciais (geralmente um token, client ID ou similar).
  2. Agora, no nosso sistema, vá até a tela de configuração da integração GS1.
  3. Cole as credenciais que você copiou nos campos correspondentes e salve.

Passo 2: Definindo os Produtos para Envio Automático

Nesta etapa, vamos dizer ao sistema qual é a "fila" de produtos que devem ser enviados.

  1. Na mesma tela de configuração, você encontrará uma opção para definir a regra de consulta.
  2. Selecione o critério que você definiu no início (por exemplo, Grupo do Produto).
  3. Escolha o item específico (ex: o grupo "Enviar para GS1").
  4. Salve a configuração. A partir de agora, todo produto que for associado a este grupo será automaticamente preparado para o envio.

Passo 3: Ativando o Agendador Automático

A mágica acontece com um agendador que roda de tempos em tempos, buscando os produtos da fila e os enviando para a GS1.

  1. Na tela de configuração, localize a opção para Ativar o Agendador ou Ativar Integração Automática.
  2. Marque a opção para ativá-la. Se houver a opção, você pode configurar a frequência (ex: a cada 1 hora).
  3. Salve as alterações.

3. Como Funciona no Dia a Dia

Com tudo configurado, o processo é muito simples:

  1. Você cadastra um novo produto no sistema.
  2. Ao preencher os campos, você o associa ao grupo, tipo ou categoria que definimos como gatilho (ex: Grupo "Enviar para GS1").
  3. Pronto! No próximo ciclo do agendador, o sistema enviará o produto para a GS1.
  4. Assim que a GS1 retornar o Código EAN, o sistema o salvará automaticamente no campo correspondente dentro do cadastro do produto.

 
4. Lidando com Possíveis Erros

Caso a GS1 encontre alguma inconsistência, ela retornará um erro.

 
Resumo da Implantação
  1. Reúna os Pré-requisitos: Tenha em mãos suas credenciais da GS1 e defina a regra de envio.
  2. Configure no Sistema: Insira as credenciais, defina a regra de consulta e ative o agendador.
  3. Use no Dia a Dia: Simplesmente associe os novos produtos ao grupo/categoria definido para que o processo ocorra automaticamente.
  4. Monitore os Erros: Fique de olho nos logs e alertas para garantir que todos os produtos sejam registrados corretamente.