✅ Vantagens Modelo 1:
- ✔ Mais objetiva e técnica – Evita informações desnecessárias para desenvolvedores que só precisam da API.
- ✔ Fácil manutenção – Não precisa ser alterada caso a interface do produto mude.
- ✔ Facilidade para integradores externos – Desenvolvedores que não usam o produto podem entender os dados sem precisar de contexto extra.

❌ Desvantagens Modelo 1:
- ✖ Desconexão com o produto – Quem usa o produto pode não saber como esses dados se refletem na interface.
- ✖ Pouca usabilidade para equipes internas – Se um analista de suporte ou um gerente de produto precisar entender os dados da API, pode ter dificuldades.

2️⃣ Modelo da Doc da API 2: Relacionando os dados da API com o produto

...

Estrutura separado pelos tipos de dados, sendo que o PDVSync é separado por microsserviços
Em cada tipo de dados existe uma quantidade enorme de informações do PDV na primeira aba + as informações da API, pode ser tornar confuso para o usuário
- Necessidade de dar foco para a API e foco para o PDV quando o usuario for procurar informações especificas
Ausência de processo de instalação do Sync
Ausência de processo Troubleshooting
Fluxos de subida de forma separada
Em cada fluxo precisa adicionar a informação do microsserviço, pois atualmente temos apenas o endPoint o que pode se tornar confuso na hora de montar uma requisição
Estudo de como implementar o processo online

Modelo da Doc de API geral

Toda documentação das API's subida, descida e online deve conter os seguintes dados:

A Regra Desconto Acréscimo poderá ter a seguintes informações:

Deck of Cards

id	dk1

Card

label	Como integrar

Este método é responsável pela criação de uma regra de desconto

Endpoint: /api/retaguarda/v3/dadosdinamicos/down/59/{versão}
Método: Post
Autenticação: Bearer token
Permissão: Retaguarda
Microserviço: PDVSync.Core.Preco

Este endpoint recebe uma lista de regra de desconto e acrescimo, permitindo vários em uma mesma requisição.

Aviso

Para que a baixa da regra de desconto e acrescimo criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 59 = regradescontoacrescimo

É necessário que o inquilino tenha o parametro 59 - regradescontoacrescimo cadastrado no controle.

Deck of Cards

id	versoes2

Card

label	V3.1

Requisição

Section

Column

width	50%

Exemplo de body da requisição

[
{
"dataHoraVigenciaFinal": "2021-06-21T14:43:18.665Z",
"dataHoraVigenciaInicial": "2021-06-21T14:43:18.665Z",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"idRetaguardaCategoria": "string",
"idRetaguardaCliente": 10,
"idRetaguardaDepartamento": "string",
"idRetaguardaFornecedor": "string",
"idRetaguardaMarca": "string",
"idRetaguardaPagamentoCondicao": "string",
"idRetaguardaPraca": "string",
"idRetaguardaProduto": "string",
"idRetaguardaProdutoEmbalagem ": "string",
"idRetaguardaRamoAtividade": "string",
"idRetaguardaRede": "string",
"idRetaguardaRegiao": "string",
"idRetaguardaRestricaoPagamentoCondicao": "string",
"idRetaguardaSecao": "string",
"idRetaguardaSubCategoria": "string",
"loteOrigem": "string",
"prioritaria": true,
"quantidadeFinal": 10,
"quantidadeInicial": 10,
"situacao": 10,
"tipo": 10,
"valor": "string"
}
]

Column

width	50%

Definições dos campos do body

Campo	Tipo	Descrição	Obrigatório	Observações
idInquilino	string	Identificador do inquilino	Sim
idProprietario	string	Identificador do proprietário	Sim
idRetaguarda	string	Identificador do grupo na retaguarda	Sim	Tamanho máximo: 100 caracteres
dataHoraVigenciaInicial	datetime	Data Inicial da vigência da regra	Sim
dataHoraVigenciaFinal	datetime	Data Final da vigência da regra	Sim
loteOrigem	string	Identificador do lote	Sim
situacao	Int	Situação do grupo	Sim	0 - Inativo , 1 - ativo
tipo	Int	Tipo da regra	Sim	0 - desconto, 1 - Acrescimo
valor	string	Valor	Sim
quantidadeInicial	Int	Quantidade Inicial	Não
quantidadeFinal	Int	Quantidade Final	Não
idRetaguardaPagamentoCondicao	string	IdRetaguarda do pagamento condicao	Não	Tamanho máximo: 100 caracteres
idRetaguardaRestricaoPagamentoCondicao	string	IdRetaguarda da restrição pagamento condição	Não	Tamanho máximo: 100 caracteres
idRetaguardaRegiao	string	IdRetaguarda da Regiao	Não
idRetaguardaPraca	string	IdRetaguarda da Praca	Não	Tamanho máximo: 100 caracteres
idRetaguardaRamoAtividade	string	IdRetaguarda do Ramo de atividade	Não
idRetaguardaRede	string	IdRetaguarda da Rede	Não	Tamanho máximo: 100 caracteres
idRetaguardaCliente	string	IdRetaguarda do Cliente	Não
idRetaguardaProduto	string	Id Retaguarda do Produto	Não
idRetaguardaFornecedor	string	IdRetaguarda do fornecedor	Não	Tamanho máximo: 100 caracteres
idRetaguardaCategoria	string	IdRetaguarda da categoria	Não	Tamanho máximo: 100 caracteres
idRetaguardaSubCategoria	string	IdRetaguarda subcategoria	Não	Tamanho máximo: 100 caracteres
idRetaguardaDepartamento	string	IdRetaguarda do departamento	Não	Tamanho máximo: 100 caracteres
idRetaguardaProdutoEmbalagem	string	idRetaguarda da embalagem do produto	Não	Tamanho máximo: 100 caracteres
prioritaria	boolean	Regra prioritaria	Não
idRetaguardaMarca	string	IdRetaguarda da Marca	Não	Tamanho máximo: 100 caracteres
idRetaguardaSecao	string	IdRetaguarda da Secao	Não	Tamanho máximo: 100 caracteres

Retorno

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

{
"data": null,
"errors": null,
"message": null,
"numberOfRecords": 8,
"success": true,
"totalTime": 2061
}

Column

width	50%

Definições dos campos do retorno

Campo	Tipo	Descrição
data	Objeto	Retorno dos dados caso tenha
errors	Objeto	Objeto contendo todos os erros encontrados.
message	String	Descrição do erro
numberOfRecords	Int	Número de arquivos processados
success	Bool	Status da requisição
totalTime	Int	Tempo total

Card

label	400 - Bad Request

Column

width	50%

Exemplo de body de retorno

{
"data": null,
"errors": {
"0": {
"IdRetaguarda": [
""
]
}
},
"message": null,
"numberOfRecords": 9,
"success": false,
"totalTime": 4077
}

Column

width	50%

Definições dos campos do retorno

Campo	Tipo	Descrição
data	Objeto	Retorno dos dados caso tenha
errors	Objeto	Objeto contendo todos os erros encontrados. Cada propriedade desse objeto é o índice do grupo enviado que está com erro.
message	String	Descrição do erro
numberOfRecords	Int	Número de arquivos processados
success	Bool	Status da requisição
totalTime	Int	Tempo total

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 13

Nova versão 14

Chave

2️⃣ Modelo da Doc da API 2: Relacionando os dados da API com o produto

Modelo da Doc de API geral

Requisição

Exemplo de body da requisição

Definições dos campos do body

Retorno

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Atalhos

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 13

Nova versão 14

Chave

2️⃣ Modelo da Doc da API 2: Relacionando os dados da API com o produto

Modelo da Doc de API geral

Requisição

Exemplo de body da requisição

Definições dos campos do body

Retorno

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno