Ir para o conteúdo principal

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

1. Linguagem e Comunicaçã

Visão
Geral
  • Seja Direto e Técnico: Use termos específicos (API Key, endpoint, ERP, PDV) e explique-os brevemente se necessário.  Evite linguagem excessivamente formal ou informal.
  • Exemplo: "A integração automatizada ocorre via API, com a ECOS coletando dados do Ilimitar."

2. Entendimento do Fluxo de Dados

  • Descreva o Caminho dos Dados: Detalhe quem inicia a comunicação, quais dados são trocados, o formato e a frequência.
  • Exemplo: "A ECOS consulta o endpoint do Ilimitar a cada 5 minutos, usando CNPJ, data de emissão e paginação para obter vendas."

3. Configuração Passo a Passo

  • Guia Claro e Replicável: Apresente os passos numerados, incluindo ações específicas (cliques, campos a preencher) e resultados esperados.
  • Exemplo:
    1. "Gere a API Key do ILLI."
    2. "Adicione a biblioteca na base do cliente."
    3. "Insira a API Key para autenticação."

4. Credenciais e Parâmetros

  • Identificação Explícita: Liste claramente todos os parâmetros de entrada (CNPJ, data, paginação) e credenciais (usuário, senha, API Key) necessárias.
  • Exemplo: "A ECOS usa usuário e senha para acessar o endpoint 'get vendas'."

5. Gerenciamento da Integração

  • Controle de Acesso: Descreva como ativar, desativar ou revogar o acesso (ex: "gerar novo PIN, redefinir chave API ou desativar usuário no Ilimitar").
  • Exemplo: "Para interromper a integração, basta gerar novo PIN, redefinir a chave API ou desativar o usuário no Ilimitar, revogando o acesso da ECOS."

6. Escopo e Limitações

  • Defina Clareza nas Entregas: Especifique o que a integração faz e o que não faz, e quais dados são compartilhados.
  • Exemplo: "Apenas informações de vendas por cartão são compartilhadas."

7. Pré-requisitos Técnicos

  • Liste Requisitos Essenciais: Inclua bibliotecas necessárias, compatibilidade com APIs (REST, JSON) e formatos de arquivo (CSV, OFX).
  • Exemplo: "É necessário que a biblioteca esteja ativa e o CNPJ do cliente seja informado à ECOS, que já possui o endpoint do Ilimitar."

8. Benefício Final

  • Contexto de Negócio: Conecte a funcionalidade técnica aos benefícios (ex: "automatizar conciliação, identificar divergências em taxas").
  • Exemplo: "

    A integração entre o PDV ILLI e a plataforma Equals automatiza(via ECOS) tem como objetivo centralizar e centralizaautomatizar a conciliação de vendas,vendas oferecendorealizadas visãcom cartão, facilitando o claracontrole dosde recebimentos."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 ECOS (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)

    1. No Gestor Ilimitar, selecione:

      • Período de até 20 dias

      • Entidade (loja)

    2. Exporte o relatório ZIP contendo os arquivos CSV por dia

    3. Acesse a Equals (ECOS) e importe os arquivos

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

     

     

    Automatizada (via API Ilimitar)

    1. Biblioteca ativa no cliente

    2. Equals consulta o endpoint GET /vendas da Ilimitar via:

      • CNPJ

      • Data de emissão

      • Paginação

    3. 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çãoDetalhes
    Valor bruto da vendaInclui taxas
    Forma de pagamentoCrédito, débito, Pix etc.
    Número do comprovanteNSU da venda
    Data/hora da transaçãoTimestamp
    Dados do clienteNome e CPF (quando disponível)
    Taxas e bandeiras aplicadasInclui taxa por parcela, antecipação etc.

     

    5. Funcionalidades da Equals (ECOS)

    • Conciliação automática entre:

      • Vendas do PDV

      • Dados das adquirentes

      • Repasse bancário

    • Interface ECOS 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âmetroTipoObservação
    CNPJStringDeve ser da loja a ser conciliada
    DataEmissaoDateUsado para filtrar as vendas
    PageIntegerPaginação de resultados
    FormaPagamentoStringApenas vendas com cartão são consultadas
    IntervaloHorárioRequisiçõ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

Voltar ao topo