Histórico da Página

...

✅ Vantagens:
- ✔ Liberdade para estruturação da documentação - Sem depender de como a documentação do PDV esta disposta.
- ✔ Maior visibilidade para desenvolvedores externos – Facilita o acesso para parceiros, startups e integradores.
- ✔ Facilidade de versionamento – É mais fácil gerenciar e documentar versões diferentes da API sem interferir no produto.
❌ Desvantagens:
- ✖ Pode gerar desconexão do produto – Se não houver sincronização eficiente, a documentação pode ficar desatualizada em relação ao produto.
- ✖ Exige manutenção separada – A equipe pode precisar de um esforço adicional para manter a documentação alinhada com as mudanças do produto.
- ✖ Estrutura pré-definida com base na documentação do PDV - Uma documentação pensada no negócio em si ao invés de API
Modelo 1 →
- ✔ Nessa documentação estamos conseguimos separar os envios conforme os micros serviços
- ✔ Demonstrar estrutura do PDVSync e seu funcionamento
- ✔ Processos
  - Descida de dados
  - Subida de dados
  - Processo Online
  - Consultas específicas LojaLoteRetorno (GET)
  - Integração de nova Loja
  - Entre outros
- ✔ Troubleshooting
- Instação ✔ Instalação do Sync

Pontos de Melhoria

Necessidade de atrelar essa doc na documentação do PDV para ter de referência
Melhorar algumas informações em ordem de prioridade
Ajustes no modelo da doc das API's
- Adicionar campos do PDV?
- Adicionar as informações referentes a v3 de forma clara
- centralizar todos os tipos de Dados existentes em apenas um lugar

...