Ir para o conteúdo principal

Manual de Implementação

1. Linguagem e Comunicação

  • 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 PDV ILLI e Equals automatiza e centraliza a conciliação de vendas, oferecendo visão clara dos recebimentos."
Voltar ao topo