Ir para o conteúdo principal

PRD - Integração ILLI x Equals

Visão Geral

A integração entre o PDV ILLI e a plataforma Equals tem como objetivo permitir a conciliação das formas de pagamento das vendas realizadas no ILLI. Isso proporcionará aos usuários previsões claras de valores e datas de recebimento, além de identificar possíveis divergências nas taxas aplicadas.


Objetivo do Produto

Facilitar a conciliação financeira das vendas realizadas no PDV ILLI, proporcionando maior visibilidade e controle sobre os valores recebíveis e identificando divergências de maneira ágil e eficiente.


Público-Alvo

  • Usuários do PDV ILLI que precisam acompanhar e conciliar pagamentos de vendas realizadas.

  • Gerentes financeiros e administradores de lojas que utilizam o Equals como ferramenta de conciliação financeira.


Documentações de APIs

API ILLI
API Equals

Funcionalidades Principais

Importação de Dados de Vendas

    • Envio dos dados de vendas realizadas no PDV ILLI para a plataforma Equals em tempo real ou em lotes.

    • Informações enviadas incluem:

      • Valor bruto da venda.

      • Forma de pagamento (cartão de crédito, débito, Pix, etc.).

  1. Conciliação Automática

    • Verificação de correspondência entre os valores registrados no PDV e os valores informados pelo Equals.

    • Identificação de discrepâncias, como diferenças nas taxas ou valores não reconhecidos.


Requisitos Técnicos

  • APIs do Equals:

    • Autenticação via Bearer Token.

    • Suporte a endpoints REST para envio e consulta de dados financeiros.

    • Utilização de webhooks para notificações de mudanças no status dos pagamentos.

  • Infraestrutura do ILLI:

    • Suporte para integração com APIs externas.

    • Conformidade com o padrão REST e JSON para comunicação.

Requisitos Funcionais

  • Integração automatizada para envio de dados das vendas ao Equals.

  • Exibição de dados financeiros consolidados no painel do usuário.

  • Geração de alertas e notificações em tempo real.

  • Relatórios com histórico de pagamentos e divergências.

Requisitos Não Funcionais

  • Segurança:

    • Criptografia para transmissão de dados.

    • Autenticação OAuth para APIs.

  • Performance:

    • Sincronização em tempo real ou quase em tempo real.

    • Tempo de resposta das APIs inferior a 500ms para operações críticas.

  • Escalabilidade:

    • Capacidade de lidar com alto volume de vendas em períodos de pico.

  • Conformidade:

    • Adequação à LGPD e regulamentações financeiras aplicáveis.


Instalação e Configuração

Clique aqui para baixar a biblioteca de Instalação
Passos para Instalação
  1. Instalação da Biblioteca

    • O responsável pela instalação deve adicionar a biblioteca de integração na base do cliente.

    • Certifique-se de que o ambiente do cliente esteja configurado para suportar APIs REST e JSON.

  2. Obtenção e Fornecimento da API Key

    • O responsável pela configuração deve gerar e fornecer a API Key do ILLI ao cliente.

  3. Configuração no Portal Equals

    • O cliente deve acessar o portal Equals e inserir a API Key fornecida no campo apropriado para autenticação e ativação da integração.


Métricas de Sucesso

  • Tempo médio para identificação e resolução de divergências.

  • Percentual de vendas conciliadas corretamente.

  • Redução no tempo gasto pelos usuários em atividades de conciliação manual.


Equipe Envolvida

  • Desenvolvedores: Maurício Francelino.

  • Stakeholders:  Hermílio Alves, Edson Barros, Maurício Francelino .