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
- Diretrizes de documentacao
- Equals
- Manual de Implantação – Integração ILLI + Equals (Conciliação de Recebíveis)
- Manual Técnico – Integração ILLI + Equals (via API ECOS)
- Overview Integração Equals
- F360
- Manual de Implantação – Integração ILLI + F360 Finanças (via Webhook)
- Manual Técnico – Integração ILLI + F360 (Webhooks)
- Overview Integração F360
- Altervision
- Visual geral : Integração Altervision
- Manual de Implantação – Integração AlterVision + Ilimitar
- Manual Técnico – Integração AlterVision + Ilimitar (via API + Biblioteca)
- Vtex
- Open Cashback
- Manual de Implantação: Integração com Open Cashback
- Visão Geral da Integração: illimitar e Open Cashback
- GSI
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:
-
Automatizar a baixa de títulos financeiros (receitas e despesas) com base nos dados bancários.
-
Reduzir o retrabalho com lançamentos manuais e evitar erros de digitação.
-
Aumentar a precisão da conciliação bancária com detecção automática de pagamentos.
-
Corrigir divergências com facilidade ao identificar títulos não correspondentes.
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
-
Profissionais da área financeira que realizam rotinas de conciliação bancária.
-
Contadores e administradores responsáveis pela integridade das informações financeiras.
-
Empresas que desejam automatizar e simplificar os processos de controle de receitas e despesas.
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:
-
Baixa automática de títulos financeiros.
-
Importação direta de extratos bancários.
-
Conciliação rápida e confiável.
-
Identificação automática de divergências.
-
Economia de tempo e esforço operacional.
Funcionalidades Principais
1. Importação de Arquivos Bancários
-
Suporte aos formatos OFX (padrão bancário) e CSV (personalizado).
-
O usuário importa o arquivo bancário exportado do seu internet banking.
-
Ao importar, o sistema lê e interpreta os dados do extrato, que incluem:
-
Data da transação
-
Valor
-
Tipo da transação (débito/crédito)
-
Descrição / Identificador bancário
-
Conta bancária de origem
-
2. Baixa Automática de Títulos
-
O sistema tenta detectar automaticamente os títulos correspondentes com base em:
-
Valor
-
Data
-
Tipo de transação (receita ou despesa)
-
-
Quando identificado corretamente:
-
O título é automaticamente baixado.
-
A baixa é registrada com os dados da transação bancária.
-
Um número de documento interno é gerado para referência.
-
3. Associação Manual de Títulos
Caso o sistema não reconheça automaticamente o título, o usuário pode:
-
Clicar na transação bancária importada.
-
Selecionar manualmente o título correspondente.
-
Confirmar a associação para concluir a baixa.
⚠️ Situações comuns em que pode ocorrer falha na detecção:
-
Diferença de valor (ex: centavos)
-
Pagamento em data diferente da prevista
-
Lançamento não registrado no sistema
4. Visualização e Edição
-
Após a associação (automática ou manual), os títulos passam a constar como baixados.
-
A tela de conciliação mostra:
-
O status da transação
-
A origem da baixa (arquivo importado)
-
Observações automáticas da transação (ex: “PIX recebido – Banco do Brasil”)
-
5. Compatibilidade e Requisitos Técnicos
-
Arquivos OFX: devem ser exportados diretamente do internet banking da instituição financeira.
-
Arquivos CSV: devem seguir o modelo aceito pelo sistema, com colunas padronizadas (disponível sob solicitação).
Considerações Finais
-
O sistema não permite baixa duplicada do mesmo título.
-
A funcionalidade pode ser usada tanto para contas a pagar quanto contas a receber.
-
É recomendável realizar testes com arquivos reais ou de demonstração antes de implementar em ambiente produtivo.
-
Para maior segurança, sempre valide os dados após a importação.
Diretrizes de documentacao
Diretrizes para Manuais de Implantação
Público-alvo:
-
Usuários técnicos (analistas, gerentes de TI, implantadores)
-
Profissionais que configuram, ativam e operam a integração
-
Podem ou não ter conhecimento técnico aprofundado
Objetivo
-
Explicar como ativar, configurar e utilizar a integração
-
Fornecer uma visão clara dos benefícios, passos e pré-requisitos
-
Instruir sem linguagem técnica excessiva
Estrutura Recomendada
-
Capa + Título
-
Exemplo:
Manual de Implantação – Integração ILLI + F360
-
Adicione versão e data se necessário
-
-
📍 Visão Geral
-
Descreva o que a integração faz
-
Liste os principais benefícios (automatização, economia, visibilidade)
-
-
✅ Pré-requisitos
-
Listar recursos, permissões, bibliotecas e credenciais necessárias
-
Ex: API Key, CNPJ cadastrado, biblioteca instalada
-
-
🧩 Estrutura da Integração
-
Se possível, inclua um diagrama simples (push/pull, sincronização)
-
Mostre quem envia e quem recebe
-
-
⚙️ Etapas de Instalação e Configuração
-
Passo a passo com numeração clara
-
Destaque botões, telas e URLs quando necessário
-
-
🧾 Dados Sincronizados
-
Tabela simples com os tipos de dados envolvidos
-
Ex: valor bruto, data da venda, bandeira, taxa
-
-
🔁 Fluxo de Operação
-
Descrever a rotina de funcionamento: o que acontece e quando
-
Ex: “a cada hora o sistema busca novas vendas”
-
-
🧠 Dicas e Boas Práticas
-
Ex: "Não envie o mesmo cupom duas vezes", "Verifique o status na plataforma X"
-
-
👥 Equipe Técnica Envolvida
-
Nome + papel de cada responsável
-
-
📎 Links Úteis
-
Documentação técnica, APIs, apresentações comerciais
-
Estilo e Linguagem
-
Evite jargões técnicos desnecessários
-
Use frases diretas e verbos no imperativo:
-
✅ "Acesse o painel"
-
❌ "Caso deseje acessar o painel, clique se quiser"
-
-
Use bullet points e tabelas para clareza
-
Destaque termos técnicos entre
backticks
ou em negrito
Diretrizes para Manuais Técnicos de Desenvolvimento
Público-alvo:
-
Desenvolvedores backend
-
Equipes de integração
-
Arquitetos de sistemas
Objetivo
-
Fornecer informações claras e precisas para implementar ou consumir a API
-
Detalhar endpoints, autenticação, payloads, respostas e regras
Estrutura Recomendada
-
Capa + Título
-
Exemplo:
Manual Técnico – Integração ILLI + Equals (API REST)
-
Incluir versão e data
-
-
🧩 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."
-
-
🔐 Autenticação
-
Descrever método (API Key, OAuth, JWT etc.)
-
Exemplos de cabeçalhos HTTP
-
-
🌐 Endpoints Principais
-
Listagem com:
-
Método HTTP (
GET
,POST
) -
URL
-
Parâmetros de query e body
-
Headers exigidos
-
-
-
📤 Exemplos de Requisição e Resposta
-
Com JSON indentado
-
Diferenciar campos obrigatórios e opcionais
-
-
🧠 Regras de Negócio
-
Validações
-
Limites de envio
-
Comportamento esperado
-
Frequência de chamadas
-
-
📊 Tratamento de Erros
-
Códigos HTTP e explicações
-
Campos como
traceId
, mensagens de fallback
-
-
🔄 Frequência e Agendamento
-
Se for por consulta periódica, detalhar intervalos e comportamento
-
Se for push (webhook), descrever assinatura e retorno esperado
-
-
🔧 Controle de Acesso e Revogação
-
Como ativar e revogar API Keys, ou desabilitar integrações
-
-
📎 Referências
-
Documentos de apoio (ex: Postman Collection, APIary)
-
Contato do responsável técnico
Estilo e Linguagem
-
Linguagem técnica, precisa e objetiva
-
Utilize exemplos reais e simplificados
-
Destaque campos e termos com
backticks
para código -
Use tabelas para listar campos e validações
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:
-
Manual (via importação de arquivos CSV)
-
Automatizada (via API REST da Ilimitar)
1. Pré-requisitos para Implantação
Manual
-
Acesso ao Gestor Ilimitar
-
Geração de relatório CSV por período (máx. 20 dias)
-
Acesso à plataforma Equals
Automatizada
-
Biblioteca Equals integrada ao sistema Ilimitar
-
API ativa no Ilimitar (chave de acesso)
-
CNPJ do cliente informado à Equals
-
Autorização via API Key + usuário no sistema
2. Formas de Integração
Manual (via CSV)
-
No Gestor Ilimitar, selecione:
-
Período de até 20 dias
-
Entidade (loja)
-
-
Exporte o relatório ZIP contendo os arquivos CSV por dia
-
Acesse a Equals e importe os arquivos
Vantagens:
✔️ Rápida de implantar
❌ Necessita de ações manuais recorrentes
Automatizada (via API Ilimitar)
-
Biblioteca ativa no cliente
-
Equals consulta o endpoint
GET /vendas
da Ilimitar via:-
CNPJ
-
Data de emissão
-
Paginação
-
-
Requisições são feitas a cada 5 minutos ou hora em hora
Vantagens:
✔️ Tempo real ou próximo
✔️ Sem ação manual
❌ Requer autenticação e biblioteca instalada
3. Autenticação e Controle de Acesso
-
A API do Ilimitar exige autenticação por API Key + usuário.
-
Para revogar o acesso:
-
Gere um novo PIN
-
Redefina a API Key
-
Desative o usuário
-
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
-
Conciliação automática entre:
-
Vendas do PDV
-
Dados das adquirentes
-
Repasse bancário
-
-
Interface Equals exibe:
-
Percentual conciliado
-
Total de vendas no período
-
Cronograma de recebimento (parcelas)
-
Taxas aplicadas por adquirente
-
Alertas de divergência (ex: antecipação indevida)
-
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
-
Solicite ativação da biblioteca Equals no Ilimitar
-
Crie um usuário técnico e gere a chave API
-
Informe o CNPJ à Equals
-
A Equals iniciará a leitura via API
8. Aspectos Comerciais
-
Integração manual: pode ser disponibilizada sem custo
-
Integração automática: pode envolver modelo comercial adicional
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:
-
Sistema de vendas (ILLI)
-
Adquirentes (ex: Cielo, Rede, Stone)
-
Bancos (valores recebidos)
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
-
A comunicação ocorre por HTTPS
-
Requisições são feitas de 5 em 5 minutos ou a cada hora
Autenticação
-
Acesso à API Ilimitar exige:
-
Usuário técnico
criado no sistema -
API Key
associada ao usuário
-
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:
-
Gere um novo PIN
-
Redefina a chave API
-
Desative o usuário
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
-
O EQUALS realiza requisições periódicas:
-
A cada 5 minutos (modo intenso)
-
Ou 1x por hora (modo normal)
-
Regras de negócio
-
A EQUALS apenas lê os dados: o ilimitar não envia nada proativo.
-
A plataforma realiza:
-
Conciliação de taxas (previstas x aplicadas)
-
Validação de bandeiras
-
Geração de relatórios por loja/data
-
-
Todas as vendas consideradas são exclusivamente com cartão
-
A conciliação parcelada considera taxas individuais por parcela e taxas de antecipação
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
-
A API segue padrão RESTful com respostas em JSON
-
Deve-se evitar flood: chamadas com intervalo inferior a 5 minutos podem ser bloqueadas
-
O sistema ECOS pode exibir:
-
% conciliado
-
total de vendas
-
discrepâncias e inconsistências
-
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á:
- Consolidar as informações de vendas do PDV ILLI com os dados da plataforma Equals.
- Automatizar a conciliação de pagamentos, eliminando processos manuais e reduzindo erros.
- Obter previsões precisas de valores e datas de recebimento.
- Melhorar a gestão financeira, proporcionando maior controle e visibilidade sobre as vendas.
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
- Gerentes financeiros que buscam maior controle e visibilidade sobre os recebimentos.
- Administradores de lojas que utilizam o Equals como ferramenta de gestão financeira.
Apresentação Comercial
Acesse a apresentação completa aqui
Documentações de APIs
- API ILLI: link para a documentação da API ILLI
- API Equals: link para a documentação da API Equals
Funcionalidades Principais
Importação de Dados de Vendas
- Envio automático dos dados de vendas do PDV ILLI para a plataforma Equals, incluindo:
- Valor bruto da venda
- Forma de pagamento (cartão de crédito, débito, Pix, etc.)
- Data e hora da venda
- Número do comprovante
- Detalhes do cliente
- Informações sobre taxas e impostos
Conciliação Automática
- Comparação dos dados de vendas do PDV ILLI com os dados da Equals, identificando:
- Divergências de valores
- Taxas incorretas
- Pagamentos não reconhecidos
Integração com Módulos Equals
- Integração com os diferentes módulos da plataforma Equals, como:
- Contas a receber
- Fluxo de caixa
- Relatórios financeiros
- Automação de tarefas financeiras, como registro de pagamentos e geração de relatórios.
Instalação e Configuração
- Baixe a biblioteca de integração: link para download
- Adicione a biblioteca na base do cliente.
- Certifique-se da compatibilidade com APIs REST e JSON.
Obtenção e Fornecimento da API Key
- Gere a API Key do ILLI.
- Forneça a API Key ao cliente.
Configuração no Portal Equals
- Acesse o portal Equals.
- Insira a API Key para autenticação.
Equipe Envolvida
- Desenvolvedores: Maurício Francelino
- Stakeholders: Hermílio Alves, Edson Barros, Maurício Francelino
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:
-
Cupons fiscais (vendas)
-
Títulos de contas a pagar e receber
Tudo isso via Webhooks — notificações em tempo real enviadas via HTTP.
1. Pré-Requisitos para Início
Antes de configurar a integração:
-
Solicite ao time do F360 o identificador único do serviço e a URL base do webhook.
-
Garanta que o CNPJ da loja esteja cadastrado corretamente no F360.
-
Consulte a documentação técnica do F360 para endpoints de centros de custo e planos de contas.
2. Endpoints Padrão
Formato da URL:
https://webhook.f360.com.br/{identificador-unico-do-servico}/{servico-consumido}
-
identificador-unico-do-servico
: gerado pelo F360 e fornecido à empresa. -
servico-consumido
: indica o tipo de informação a ser enviada. Exemplos:-
f360-cupom-fiscal
-
f360-{id}-titulo
-
3. Envio de Cupons Fiscais
Use o endpoint f360-cupom-fiscal
para enviar registros de venda.
Requisição:
-
Método:
POST
-
Content-Type:
application/json
-
Envio assíncrono (o status do processamento deve ser consultado no próprio F360)
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:
-
NumeroCupom
,CNPJEmitente
,Data
,MeioPagamento
,FormaPagamento
,Valor
Observações:
-
Cupons com o mesmo número devem ser enviados uma única vez.
-
Cada request deve conter cupons de um único CNPJ e dia específico.
4. Envio de Títulos (Contas a Pagar e Receber)
Use o endpoint f360-{id}-titulos
para enviar registros financeiros.
Requisição:
-
Método:
POST
-
Content-Type:
application/json
-
Operação exclusiva para inclusão de novos registros
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
-
Evite duplicidade: envie cupons e títulos apenas uma vez por número/identificador.
-
Valide o JSON antes do envio.
-
Use os endpoints públicos da API F360 para validar centros de custo e planos de contas.
-
Monitore o rastreioId retornado em caso de sucesso para acompanhar o status da requisição
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
-
Centralização das operações financeiras (unificação)
-
Agilidade no envio de dados
-
Redução de erros manuais (retrabalho)
-
Visibilidade e rastreabilidade dos dados enviados
-
Confiabilidade na conciliação de vendas e pagamentos
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}
-
{identificador-unico-do-servico}
: fornecido pelo F360 após solicitação. -
{servico-consumido}
: exemplos:-
f360-cupom-fiscal
-
f360-{id}-titulos
-
Envio de Cupons Fiscais
POST /{identificador}/f360-cupom-fiscal
Regras Técnicas
-
A request é assíncrona.
-
Content-Type: application/json
-
Cupom e CNPJ devem ser únicos por requisição.
-
Várias formas de pagamento podem ser inseridas no mesmo cupom.
-
Várias vendas podem ser inseridas no mesmo JSON, desde que sejam do mesmo CNPJ e data (yyyy-MM-dd).
📤 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
-
NumeroCupom
,CNPJEmitente
,Data
,MeioPagamento
,FormaPagamento
,Valor
Envio de Títulos (Contas a Pagar e Receber)
POST /{identificador}/f360-{id}-titulos
Regras Técnicas
-
Só é possível criar novos registros (
insert only
) -
Content-Type: application/json
-
Cada título deve ter ao menos uma
parcela
e umrateio
-
As somas devem fechar:
-
Soma das parcelas = valor do título
-
Soma dos rateios = valor da parcela correspondente
-
📤 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
-
cnpj
,tipoTitulo
,numeroTitulo
,clienteFornecedor
,emissao
,valor
,tipoDocumento
,contaBancaria
,meioPagamento
,parcelas
,rateio
Respostas da API
HTTP Code | Significado | Payload |
---|---|---|
200 | Sucesso | {"rastreioId": "<UUID>"} |
500 | Erro |
JSON com |
Observações Técnicas
-
Utilize a API pública do F360 para listar:
-
Planos de contas
-
Centros de custo
-
-
FormaPagamento
aceita valores conforme a Tabela de Bandeiras (ex: Visa, Pix, Elo, etc.) -
Campos de datas devem seguir o formato ISO:
-
yyyy-MM-ddTHH:mm:ss
para timestamps -
yyyy-MM-dd
para datas simples
-
-
Campos booleanos: use
true
oufalse
(não strings)
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:
- Consolidar informações de vendas, contas a pagar e contas a receber em uma única plataforma.
- Automatizar o envio de títulos e cupons fiscais para o F360, eliminando processos manuais.
- Conciliar transações automaticamente, identificando divergências com precisão.
- Acompanhar o status das transações e visualizar relatórios detalhados.
- Otimizar a gestão financeira, reduzindo tempo e recursos.
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
- Gerentes financeiros que buscam centralizar e automatizar a conciliação financeira.
- Administradores de lojas que utilizam o F360 para gestão de vendas e finanças.
- Profissionais que necessitam de informações precisas e em tempo real sobre as transações do sistema ILLI.
Apresentação Comercial
Acesse a apresentação
Descrição:
- Simplifique a gestão financeira do seu negócio com a integração ILLI e F360.
- Automatize o envio de dados, elimine tarefas manuais e tenha uma visão completa das suas operações.
- Principais benefícios:
- Centralização de informações financeiras.
- Conciliação automática e precisa.
- Redução de erros e retrabalho.
- Economia de tempo e recursos.
- Maior controle e visibilidade.
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
- Envio automático de dados de vendas, contas a pagar e contas a receber do sistema ILLI para a plataforma F360.
- Sincronização em tempo real ou em lotes, de acordo com a necessidade do usuário.
- Dados enviados incluem:
- Valor bruto da venda
- Forma de pagamento (cartão de crédito, débito, Pix, etc.)
- Informações detalhadas de títulos de contas a pagar e a receber, como:
- Número do título
- Data de emissão
- Data de vencimento
- Valor
- Cliente
- Centro de custo
- Plano de contas
- Informações de cupons fiscais, como:
- Número do cupom fiscal
- Data de emissão
- Valor total
- Itens da venda
- Impostos
2. Conciliação Automática
- Comparação dos dados enviados pelo ILLI com os dados registrados no F360, identificando:
- Divergências de valores
- Taxas divergentes
- Valores não reconhecidos
- Erros de cadastro
- Geração de alertas e notificações em caso de divergências, facilitando a correção e o acompanhamento.
Equipe Envolvida
- Desenvolvedores: Maurício Francelino.
- Stakeholders: Hermílio Alves, Edson Barros, Maurício Francelino.
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
- Gerentes e administradores de lojas que utilizam o sistema Linx e desejam monitorar o fluxo de clientes.
- Analistas de BI e operações que necessitam de dados precisos sobre o fluxo de clientes para análise e tomada de decisão.
- Equipes de TI responsáveis pela gestão de integrações entre sistemas.
Apresentação Comercial
Documentações de APIs
Funcionalidades Principais
Integração com o iSnapp
- O AlterVision realiza solicitações ao iSnapp, que acessa os dados do Linx.
- O iSnapp processa e devolve as informações solicitadas de forma eficiente e precisa.
Autenticação Segura
- Autenticação via API Key no iSnapp para garantir segurança no acesso aos dados.
- Controle de permissões para restringir acessos indevidos.
Consulta de Dados
- Consulta de informações de fluxo de clientes por loja e período.
- Obtenção de dados em tempo real para análise.
Monitoramento de Fluxo de Clientes
- Registra e exibe o número de entradas e saídas de clientes em tempo real.
- Integração com dashboards para visualização dinâmica dos dados.
- Análise da taxa de conversão no aplicativo de venda.
Relatórios e Análises
- Geração de relatórios históricos de fluxo de clientes.
- Identifica padrões de visitação e comportamento do consumidor.
API para Análise de Dados
- Desenvolvimento de uma API para integrar os dados de fluxo de pessoas e taxa de conversão com um stage dedicado à análise de dados.
- Processamento e disponibilização dos dados em tempo real para análises avançadas.
- Extração de insights sobre o comportamento do cliente e desempenho das lojas.
Equipe Envolvida
- Responsável Técnico: Maurício Francelino.
- Stakeholders: Hermílio Alves, Edson Barros, Maurício Francelino.
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
-
Gerentes de loja que desejam entender o comportamento de fluxo e conversão.
-
Analistas de BI que utilizam dados operacionais para embasar decisões estratégicas.
-
Equipes de implantação ou TI responsáveis por ativar e configurar a integração.
Pré-Requisitos
-
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).
-
-
Criação de usuário com permissão de “Gestor” no Ilimitar
-
Necessário para autenticação nas chamadas da API de vendas.
-
-
Envio de credenciais à AlterVision
-
Usuário e senha de acesso Ilimitar (ou token) para consumo seguro da API.
-
-
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)
-
A AlterVision coleta dados das câmeras e envia para seu servidor.
-
A AlterVision consome os dados de vendas do Ilimitar via API para cruzar com o fluxo.
-
A taxa de conversão é calculada e exibida no painel do cliente AlterVision.
Etapas de Instalação
-
Solicitar a biblioteca
supademo
ao responsável técnico (Maurício Francelino) -
Instalar a biblioteca no ambiente do cliente
-
Criar um usuário gestor no Ilimitar
-
Atribuir permissões mínimas necessárias para leitura das vendas
-
-
Compartilhar o login com a equipe da AlterVision
-
Testar conexão API ↔ Ilimitar
-
Validar autenticação e retorno de dados
-
-
Validar dados no painel da AlterVision
-
Verificar se as taxas de conversão estão sendo exibidas corretamente
-
Boas Práticas
-
Crie um usuário técnico dedicado à integração
-
Evite reutilizar usuários administrativos
-
Valide com o cliente final o período de histórico desejado (ex: 7, 30 ou 90 dias)
-
Garanta a atualização da biblioteca, quando aplicável
-
Verifique se as câmeras estão corretamente posicionadas e calibradas
Fluxo de Operação
-
A cada intervalo definido (ex: 5 minutos):
-
A AlterVision consulta a API da Ilimitar
-
Recebe os dados de vendas por loja e horário
-
Relaciona com o número de entradas e saídas coletadas
-
Atualiza o painel com a taxa de conversão da loja
-
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:
-
Coleta de dados da câmera → fluxo
-
Requisições API → vendas
-
Cálculo da taxa de conversão no back-end da AlterVision
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:
-
Python ≥ 3.8
-
Dependências:
requests
,pydantic
,datetime
-
Acesso HTTPS ao domínio da Ilimitar
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')
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
-
A AlterVision executa a consulta de dados de vendas:
-
Em tempo real ou a cada 5/15 minutos
-
Sempre referenciada por data e loja
-
-
Os dados de fluxo são combinados com o número de vendas para calcular:
taxa_conversao = vendas_realizadas / pessoas_que_entraram
Retorno e Exibição
Todos os dados são utilizados internamente pela AlterVision para alimentar:
-
Painéis por loja
-
Relatórios de conversão diária
-
Comparativos de loja, horário, feriados, promoções etc.
Tratamento de Erros
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
-
Lojistas e administradores de e-commerce que utilizam a VTEX e precisam gerenciar produtos e pedidos via Illi ERP.
-
Equipes de TI responsáveis pela gestão e manutenção das integrações entre sistemas.
-
Times de vendas e operações que necessitam de uma visão consolidada do estoque e dos pedidos.
Apresentação Comercial
Documentação de APIs
Funcionalidades Principais
Integração com o iSnapp
-
O iSnapp atua como middleware, garantindo a comunicação eficiente entre Illi e VTEX.
-
Processamento e sincronização de dados de forma segura e eficiente.
Autenticação Segura
-
Autenticação via API Key para garantir acesso controlado.
-
Controle de permissões para restringir acessos indevidos.
Consulta de Produtos
-
Sincronização automática do catálogo de produtos do Illi com a VTEX.
-
Atualização de informações de estoque, descrição e preço em tempo real.
Registro de Pedidos
-
Captura automática de pedidos realizados na VTEX e envio ao Illi ERP.
-
Atualização do status do pedido em tempo real.
Consulta de CEP
-
Endpoint para verificação de endereço com base no CEP informado.
Consulta e Cadastro de Vendedores
-
Permite a busca e o registro de vendedores na plataforma Illi via API.
Relatórios e Análises
-
Geração de relatórios sobre pedidos, estoque e performance de vendas.
-
Dashboards para monitoramento em tempo real.
Equipe Envolvida
-
Responsável Técnico: Maurício Francelino.
-
Stakeholders: Hermílio Alves, Edson Barros, Maurício Francelino.
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:
- Midway: É a biblioteca responsável por gerenciar as interações e solicitações de cashback. Ela deve ser configurada em uma forma de pagamento específica dentro do Ilimitar para funcionar
- API Open Cashback: Esta biblioteca trabalha em conjunto com a Midway para garantir a comunicação entre os dois sistemas.
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.
-
Instale as Bibliotecas
- Acesse a Ilha Store no seu Ilimitar.
- Instale as bibliotecas Midway e API Open Cashback.
- Lembre-se: A API Open Cashback depende da Midway para funcionar, então ambas precisam ser instaladas.
-
Associe a Midway a uma Forma de Pagamento
- No sistema Ilimitar, acesse o módulo de configuração de Formas de Pagamento.
- Escolha ou crie uma forma de pagamento específica para registrar as operações de cashback.
- Nesta forma de pagamento, associe a biblioteca Midway. É essa associação que ativa a funcionalidade durante a venda.
- Importe o Catálogo de Produtos
-
-
- Para que o Open Cashback aplique as regras de recompensa corretamente, ele precisa reconhecer seus produtos.
- A integração permite a importação do seu catálogo de produtos do Ilimitar para a plataforma Open Cashback
-
3. Fluxo de Venda no Ilimitar
Com a integração ativa, veja como o processo funcionará no seu dia a dia:
-
Venda para Cliente Já Cadastrado no Open Cashback
- Durante a venda no Ilimitar, o sistema consultará o saldo de cashback do cliente na plataforma Open Cashback.
- O saldo disponível será exibido, e o cliente terá a opção de utilizá-lo na compra.
- Venda para um Novo Cliente
- Se o cliente for novo, o sistema oferecerá a opção de cadastrá-lo no programa de fidelidade do Open Cashback.
- Ao aceitar, dados como e-mail, celular e data de nascimento serão solicitados para criar a carteira virtual do cliente com saldo zerado
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
- Fidelização de Clientes: Incentiva os clientes a retornarem à loja para utilizar o saldo acumulado em sua carteira virtual.
- Campanhas Inteligentes: Permite a criação de regras de cashback específicas e campanhas personalizadas diretamente na plataforma Open Cashback.
- Experiência de Venda Fluida: Todo o processo de consulta, utilização e cadastro no programa de cashback ocorre de forma transparente dentro do fluxo de venda do Ilimitar, sem interrupções.
3. Como Funciona na Prática?
O processo foi desenhado para ser simples tanto para o lojista quanto para o cliente final.
-
Para o Lojista:
- A configuração no Ilimitar é feita associando o componente de integração (Midway) a uma forma de pagamento específica.
- O catálogo de produtos do Ilimitar é importado para o Open Cashback, que aplicará as regras de cashback com base nesses produtos.
- As promoções do Open Cashback são independentes e não interagem com o motor de promoções padrão do Ilimitar.
Para o Cliente Final:
- Cliente já cadastrado: No momento da venda, o sistema consulta e informa o saldo de cashback disponível, oferecendo a opção de usá-lo.
- Cliente novo: O sistema oferece a oportunidade de participar do programa, solicitando dados básicos para criar uma nova carteira virtual.
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.
- Acesse o portal GS1 Brasil.
- Faça o login com seu usuário e senha.
- No menu, vá para Minha Conta e depois em APPs.
- 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:
- Início: O agendador de tarefas inicia o processo.
- 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.
- Envio para a GS1: Se encontrar produtos, o sistema os envia para a GS1 através da nossa API de integração.
- Recebimento do Código EAN: A GS1 processa as informações e retorna o Código EAN para cada produto.
- Atualização no Sistema: Nosso sistema salva automaticamente o código EAN recebido no cadastro do produto.
- 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.
- Acesse o site do Cadastro Nacional de Produtos (CNP).
- Faça o seu login.
- Clique no botão Cadastrar Novo Produto.
- Uma janela aparecerá com informações importantes:
- GTIN-13: Para cadastro de produtos individuais.
- GTIN-14: Utilizado para caixas ou embalagens de transporte.
- Siga o passo a passo preenchendo as informações solicitadas, como nome do produto, marca, imagens, etc.
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:
- Descrição inválida.
- Código do país inválido.
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.
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:
- Conta na GS1 Brasil: Você precisa ter um cadastro ativo e acesso ao portal da GS1. É de lá que virão suas credenciais.
- Produtos Cadastrados no Sistema: Seus produtos devem estar previamente cadastrados no nosso sistema, mesmo que ainda sem o código EAN.
- Definição da Regra de Envio: Decida qual critério o sistema usará para saber quais produtos devem ser enviados à GS1. Recomendamos usar um Grupo, Tipo ou Categoria específico para isso (ex: um grupo chamado "Enviar para GS1").
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
- 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).
- Agora, no nosso sistema, vá até a tela de configuração da integração GS1.
- 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.
- Na mesma tela de configuração, você encontrará uma opção para definir a regra de consulta.
- Selecione o critério que você definiu no início (por exemplo, Grupo do Produto).
- Escolha o item específico (ex: o grupo "Enviar para GS1").
- 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.
- Na tela de configuração, localize a opção para Ativar o Agendador ou Ativar Integração Automática.
- Marque a opção para ativá-la. Se houver a opção, você pode configurar a frequência (ex: a cada 1 hora).
- Salve as alterações.
3. Como Funciona no Dia a Dia
Com tudo configurado, o processo é muito simples:
- Você cadastra um novo produto no sistema.
- Ao preencher os campos, você o associa ao grupo, tipo ou categoria que definimos como gatilho (ex: Grupo "Enviar para GS1").
- Pronto! No próximo ciclo do agendador, o sistema enviará o produto para a GS1.
- 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.
- Erros Comuns: "Descrição inválida", "Código do país inválido", entre outros.
- O que fazer?
- O ideal é configurar um alerta por e-mail para ser notificado quando um erro ocorrer.
- No sistema, acesse a fila de processamento da integração GS1 para ver o log de erros e identificar o motivo da falha.
- Corrija os dados do produto diretamente no cadastro.
- Após a correção, coloque o produto de volta na fila para que seja enviado novamente no próximo ciclo.
Resumo da Implantação
- Reúna os Pré-requisitos: Tenha em mãos suas credenciais da GS1 e defina a regra de envio.
- Configure no Sistema: Insira as credenciais, defina a regra de consulta e ative o agendador.
- Use no Dia a Dia: Simplesmente associe os novos produtos ao grupo/categoria definido para que o processo ocorra automaticamente.
- Monitore os Erros: Fique de olho nos logs e alertas para garantir que todos os produtos sejam registrados corretamente.