...
Pre-Requisitos para instalação do Client:
...
Onde deverá conter as informações de loja, inquilino, parâmetros, etc.
Cadastrados cadastrados e configurados corretamente para realizar a troca de informações com o Client, segue abaixo os passos para configuração do ambiente no Server:
1° - Criação Inquilino
O inquilino é criado normalmente no início de um contrato com uma retaguarda através da API de controle conforme exemplo abaixo:
URL: https://pdvsync-core-controle-qa-aadivv24nq-ue.a.run.app/api/pdvsyncserver/inquilinos
Post
pela equipe do PDVSync pelo email: [email protected], com as seguintes informações:
Será retornado o IdInquilino e o token authorization para inclusão no pdvsync e nas api's dos passos seguintes.
2º - Cadastrar os parâmetros, conforme exemplo:
Incluir Authorization OAuth2.0 conforme retornado no email.
endpoint: https://pdvsync.varejo.totvs.com.br/controle/api/pdvsyncserver/parametros
Post
[{
"idIdentificacaoExternaidInquilino": "IdDoInquilino01-01", → Identificação do inquilino>/*O código do IdInquilino conforme retornado no email.*/
"nometipoProcesso": " ", → <Nome do inquilino>1,/* OnLine = 0, Descida = 1, Subida = 2*/
"situacaoquantidadeRegistros": " ", → Podem seguir os seguintes status "Inativo(0)", "Ativo(1)", "Pendente(2)"
"envioDadoTipo": "0", → tipo de envio do dado para a retaguarda em caso de retornos, utiliza 0 por enquanto ?????
"envioDado": "", → dependendo do tipo de envio preencher a informação relevante, vazio por enquanto ???
"connectionString": "", → está relacionado com a informação anterior, vazio por enquanto ???
"lote": "0" → não utilizado ainda, utilizar 0 por enquanto.
}
O código do IdInquilino é fornecido automaticamente pelo Totvs RAC após o envio do serviço.
...
1000,
"tempoChamada": 2000,
"tempoExpurgoLogs": 365,
"tipoDado": {
"codigoTipo": 1,
"descricaoTipo": "Loja",
"tipoUtilizador": 0,/*ClienteDown = 0, Server = 1, ClienteUp = 2, ClienteOnLine = 3 */
"tipoProcesso": 0 /*Criacao = 0, Atualizacao = 1, Interno = 2*/
}
}]
Lista de Parâmetros:
codigoTipo | descricaoTipo | tipoProcesso |
0 | Cliente | Down |
1 | Loja | Down |
2 | Motivo | Down |
3 | Perfil | Down |
4 | Usuario | Down |
6 | Compartilhamento | Down |
7 | Imposto | Down |
8 | Ncm | Down |
9 | PisCofins | Down |
12 | Produto | Down |
13 | Preco | Down |
14 | Estoque | Down |
15 | Operadora | Down |
16 | DadoComplementar | Down |
17 | CondicaoPagto | Down |
18 | FormaPagto | Down |
19 | Venda | Up |
20 | Caixa | Up |
22 | Troca | Up |
23 | VendaCustodiaXml | Up |
25 | Cliente | Up |
26 | PreVenda | Up |
54 | AlteracaoEstoque | Down |
55 | PreVenda | Down |
3º - Abrir Lote com Parâmetro 01 - Loja
Incluir Authorization OAuth2.0 conforme retornado no email.
endpoint: https://pdvsync.varejo.totvs.com.br/controle/api/retaguarda/inquilinolotesexternos
Post
{
"status": "InicioEnvio",
"tipoLote": [
1
],
"idInquilino": "" /*O código do IdInquilino conforme retornado no email.*/
}
Response:
{
"success": true,
"message": "",
"data": {
"loteOrigem": "20221004175001554",
"mensagem": null,
"status": 0,
"tipoLote": [
6
],
"id": "DLoi3SX5HDoPOcDlyf0m",
"idInquilino": "",
"dataAtualizacao": "2022-10-04T17:50:01.6441804Z",
"dataCadastro": "2022-10-04T17:50:01.6442468Z",
"_expandables": []
}
}
4º - Cadastro de uma Loja
**Os dados de cadastros devem ser enviados nas propriedades do json abaixo.
endpoint: https://pdvsync-core-dadosbasicos-prd-q6yz66olca-rj.a.run.app/api/retaguarda/lojas
Post
[
{
"razaoSocial": " ",
"nomeFantasia": " ",
"cnpj": " ", /*obrigatório e valido - 14 caracteres*/
"inscricaoEstadual": " ", /*obrigatório - 2 e 14 caracteres*/
"inscricaoMunicipal": " ", /*obrigatório - até 15 caracteres*/
"endereco": " ",
"numero": " ",
"complemento": " ",
"bairro": " ",
"cidade": " ",
"estado": " ",
"siglaUf
{
"success": true,
"message": "",
"data": {
"idIdentificacaoExterna": "Tupan",
"nome": "Tupan",
"situacao": 1,
"envioDadoTipo": 0,
"envioDado": "",
"connectionString": "",
"clientId": null,
"clientSecret": null,
"usuario": null,
"senha": null,
"tokenUrl": null,
"id": "4rlMuI3YwrWO8NKtvE8V", → código gerado pelo TOTVS RAC
"idInquilino": null,
"dataAtualizacao": "2022-10-04T14:50:25.2424018Z",
"dataCadastro": "2022-10-04T14:50:25.2424462Z",
"_expandables": []
}
}
2º - Cadastrar os parâmetros.
Post
{
"idInquilino": "LAxcSC2vkgynDwGtWreo",
"QuantidadeRegistros": 100,
"TempoChamada": 2,
"TempoExpurgoLogs": 130000,
"TipoDado": {
"CodigoTipo": 14,
"DescricaoTipo": "Estoque",
"TipoUtilizador": 1
},
"TipoProcesso": 1
}
Lista de Parâmetros:
codigoTipo | descricaoTipo | tipoUtilizador | tipo |
47 | AlteracaoNcm | 1 | Down |
9 | PisCofins | 1 | Down |
23 | VendaCustodiaXml | 2 | Online |
0 | Cliente | 0 | Online |
20 | Caixa | 2 | Up |
40 | AlteracaoCliente | 1 | Down |
13 | Preco | 1 | Down |
1 | Loja | 1 | Down |
8 | Ncm | 1 | Down |
3 | Perfil | 1 | Down |
16 | DadoComplementar | 1 | Down |
14 | Estoque | 1 | Down |
18 | FormaPagto | 1 | Down |
19 | Venda | 2 | Up |
15 | Operadora | 1 | Down |
2 | Motivo | 1 | Down |
6 | Compartilhamento | 1 | Down |
4 | Usuario | 1 | Down |
22 | Troca | 2 | Up |
25 | Cliente | 2 | Up |
Exemplo do Parâmetro:
{
"success": true,
"message": " ",
"data": [
{
codigoUFIBGE": " ", /*obrigatório - 2 caracteres*/
"tipoProcessocodigoMunicipioIbge": 1," ", /*obrigatório - 7 caracteres*/
"quantidadeRegistroscep": 10000,
"", /*obrigatorio*/
"tempoChamadatelefone": 2.0,
"tempoExpurgoLogs": 130000.0"", /*obrigatório - 6 e 14 caracteres*/
"codigoIdentificacaoLoja": "",
"tipoDadomodeloFiscal": {
0,
"idregimeTributario": null1,
"codigoTiporede": 47,"", /*obrigatório*/
"descricaoTipo"numeroLoja": "AlteracaoNcm0",
"tipoUtilizadoridRetaguardaRede": 1"",
"tipoProcesso"codigoMaster": 0" ",
"_expandablesnomeMaster": []" ",
}"situacao": 1,
"ididInquilino": " 6eYL6pa5dsvQsKbKwIXy ", /*Gerado no passo 1*/
"idRetaguarda": "3 ", /*código da loja na retaguarda*/
"idInquilinoidProprietario": " YchOUFQPn2i7plLpsay9 ", /*compartilhamento da loja*/
"dataAtualizacaoloteOrigem": " 2022-08-05T15:10:21.604886Z",
"dataCadastro": "2022-08-05T15:10:21.604888Z",
"_expandables": []
}
" /*Gerado no passo 3*/
}
]
5º - Fechar lote de loja
endpoint: https://pdvsync-core-controle-prd-q6yz66olca-rj.a.run.app/api/retaguarda/inquilinolotesexternos/{idInquilino}/{loteOrigem}
metodo: PUT
{idInquilino} - Gerado no passo 01
{loteOrigem} - Gerado no passo 03
6º 3º - Abrir Lote com Parâmetro 06 - CompartilhamentoPost
{
"status": 0,
"tipoLote": [
6
],
"idInquilino": "4rlMuI3YwrWO8NKtvE8V",
}
Response:
Incluir Authorization OAuth2.0 conforme retornado no email.
endpoint: https://pdvsync.varejo.totvs.com.br/controle/api/retaguarda/inquilinolotesexternos
Post
{
"status": "InicioEnvio",
"tipoLote": [
{
"success": true,
"message": "",
"data": {
"loteOrigem": "20221004175001554",
"mensagem": null,
"status": 0,
"tipoLote": [
6
],
"ididInquilino": "DLoi3SX5HDoPOcDlyf0m"," /*O código do IdInquilino conforme retornado no email.*/
}
Response:
{
"success": true
"idInquilino": "4rlMuI3YwrWO8NKtvE8V",
"dataAtualizacao": "2022-10-04T17:50:01.6441804Z",
"dataCadastromessage": "2022-10-04T17:50:01.6442468Z",
"_expandablesdata": []{
}
}
4º - Criar Compartilhamento
Post
"loteOrigem": "20221004175001554",[
{
"IdRetaguardaLojamensagem": ""null,
"IdRetaguardastatus": "32796d0b-8399-490e-b972-1db212c514fa"0,
"IdProprietario": "32796d0b-8399-490e-b972-1db212c514fa"tipoLote": [
6
],
"IdInquilinoid": "4rlMuI3YwrWO8NKtvE8VDLoi3SX5HDoPOcDlyf0m",
"NomeCompartilhamentoidInquilino": "PDV Lupan Master",
"dataAtualizacao"Nivel": 0: "2022-10-04T17:50:01.6441804Z",
"IdRetaguardaPaidataCadastro": "2022-10-04T17:50:01.6442468Z",
"loteOrigem_expandables": "20221004175001554"[]
},}
}
7º - Criar Compartilhamento
endpoint: https://pdvsync-core-controle-prd-q6yz66olca-rj.a.run.app/api/retaguarda/compartilhamentos
Post
[
{
"IdRetaguardaLoja": "3f054f05-ee67-407b-935d-9db0fc5e7c58",
"IdRetaguarda": "3f054f0532796d0b-ee678399-407b490e-935db972-9db0fc5e7c581db212c514fa",
"IdProprietario": "3f054f0532796d0b-ee678399-407b490e-935db972-9db0fc5e7c581db212c514fa",
"IdInquilino": "4rlMuI3YwrWO8NKtvE8V",
"NomeCompartilhamento": "PDV Lupan LojaMaster",
"Nivel": 10,
"IdRetaguardaPai": "32796d0b-8399-490e-b972-1db212c514fa",
"loteOrigem": "20221004175001554"
}
]Response:,
{
"success": true,
"messageIdRetaguardaLoja": "3f054f05-ee67-407b-935d-9db0fc5e7c58",
"IdRetaguarda": "3f054f05-ee67-407b-935d-9db0fc5e7c58",
"IdProprietario": "3f054f05-ee67-407b-935d-9db0fc5e7c58",
"IdInquilino": "",
"NomeCompartilhamento": "PDV Loja",
"Nivel": 1,
"IdRetaguardaPai": "",
"loteOrigem": "20221004175001554"
}
]
Response:
{
"success": true,
"message": "compartilhamento inserido com sucesso: [compartilhamento inserido com sucesso: [{\"IdRetaguarda\":\"32796d0b-8399-490e-b972-1db212c514fa\",\"IdProprietario\":\"32796d0b-8399-490e-b972-1db212c514fa\",\"NomeCompartilhamento\":\"PDV Lupan Master\",\"Nivel\":0,\"IdRetaguardaPai\":\"\",\"LoteOrigem\":\"20221004175001554\",\"Lote\":null,\"IdRetaguardaLoja\":\"\",\"Id\":null,\"IdInquilino\":\"4rlMuI3YwrWO8NKtvE8V\",\"DataAtualizacao\":\"0001-01-01T00:00:00\",\"DataCadastro\":\"0001-01-01T00:00:00\",\"_expandables\":[]},{\"IdRetaguarda\":\"3f054f0532796d0b-ee678399-407b490e-935db972-9db0fc5e7c581db212c514fa\",\"IdProprietario\":\"3f054f0532796d0b-ee678399-407b490e-935db972-9db0fc5e7c581db212c514fa\",\"NomeCompartilhamento\":\"PDV Lupan LojaMaster\",\"Nivel\":10,\"IdRetaguardaPai\":\"32796d0b-8399-490e-b972-1db212c514fa\",\"LoteOrigem\":\"20221004175001554\",\"Lote\":null,\"IdRetaguardaLoja\":\"3f054f05-ee67-407b-935d-9db0fc5e7c58\",\"Id\":null,\"IdInquilino\":\"4rlMuI3YwrWO8NKtvE8V\",\"DataAtualizacao\":\"0001-01-01T00:00:00:\"\",\"DataCadastroDataAtualizacao\":\"0001-01-01T00:00:00\",\"_expandablesDataCadastro\":[]}].",
"data": null
}
5º - Fechar o Lote
...
\"0001-01-01T00:00:00\",\"_expandables\":[]},{\"IdRetaguarda\":\"3f054f05-ee67-407b-935d-9db0fc5e7c58\",\"IdProprietario\":\"3f054f05-ee67-407b-935d-9db0fc5e7c58\",\"NomeCompartilhamento\":\"PDV Loja\",\"Nivel\":1,\"IdRetaguardaPai\":\"32796d0b-8399-490e-b972-1db212c514fa\",\"LoteOrigem\":\"20221004175001554\",\"Lote\":null,\"IdRetaguardaLoja\":\"3f054f05-ee67-407b-935d-9db0fc5e7c58\",\"Id\":null,\"IdInquilino\":\"\",\"DataAtualizacao\":\"0001-01-01T00:00:00\",\"DataCadastro\":\"0001-01-01T00:00:00\",\"_expandables\":[]}].",
"data": null
}
8º - Fechar o Lote
endpoint: https://pdvsync-core-controle-prd-q6yz66olca-rj.a.run.app/api/retaguarda/inquilinolotesexternos/{idInquilino}/{loteOrigem}
metodo: PUT
{idInquilino} - Gerado no passo 01
{loteOrigem} Gerado no passo anterior
9º - Cadastrar os parâmetros comerciais para a consulta de operações de vendas e caixa
URL: https://pdvsync.varejo.totvs.com.br/comercial/api/pdvsyncserver/parametros
Post
[
{
"idInquilino": "", /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo
6º - Abrir lote com Parâmetro 01 - Loja
Post
{
"status": 0,
"tipoLote": [
1
],
"idInquilino": "4rlMuI3YwrWO8NKtvE8V",
}
7º - Cadastro de uma Loja
Post
[
{
"razaoSocial": " ",
"nomeFantasia": " ",
"cnpj": " ",
"inscricaoEstadual": " ", --
"inscricaoMunicipal": " ",
"endereco": " ",
"numero": " ",
"complemento": " ",
"bairro": " ",
"cidade": " ",
"estado": " ",
"siglaUf": " ",
"codigoUFIBGE": " ",
"codigoMunicipioIbge": " ",
"cep": "",
"telefone": "",
"codigoIdentificacaoLoja": "",
"modeloFiscal": "",
"regimeTributario": "",
"rede": "",
"numeroLoja": "0",
"idRetaguardaRede": "",
"codigoMaster": " ",
"nomeMaster": " ",
"situacao": 1,
"idInquilinotipo": " ", - Gerado no passo 11,
"idRetaguardavalor": "3 10", - Gerado no passo 4
},
{
"idProprietario": " ",- Gerado no passo 4
"loteOrigemidInquilino": "" - Gerado no passo 6
}
]
8º - Fechar lote de loja
{idInquilino} - , /*Gerado no passo 01
{loteOrigem} - Gerado no passo 06
9º - Cadastrar os parâmetros comerciais para a consulta de operações de vendas e caixa
URL: https://pdvsync-core-comercial-qa-aadivv24nq-ue.a.run.app/api/pdvsyncserver/parametros
Post
*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 2,
"tipo": 2,
"valor": "10"
},[
{
"idInquilino": "vAh0y1bKvHMfwsZxDKfW", - /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 13,
"tipo": 13,
"valor": "10"
},
{
"idInquilino": "vAh0y1bKvHMfwsZxDKfW", /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 24,
"tipo": 24,
"valor": "10"
},
{
"idInquilino": "vAh0y1bKvHMfwsZxDKfW", /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 3,
"tipo": 3,
"valor": "10"
},
{
"idInquilino": "vAh0y1bKvHMfwsZxDKfW",
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 4,
"tipo": 4,
"valor": "10"
},
{
"idInquilino": "vAh0y1bKvHMfwsZxDKfW",
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 5,
"tipo": 0,
"valor": "https://pdvsync-core-fila-qa-aadivv24nq-ue.a.run.app/api/stub/historicovenda"
}
...
",
"codigo": 5,
"tipo": 0,
"valor": "https://pdvsync-core-fila-prd-q6yz66olca-rj.a.run.app/api/stub/historicovenda"
}
]
10º Baixar Serviços Clients
Instalação dos Serviços UP, DOWN, CONTROLE e API:
Desinstalação dos Serviços UP, DOWN, CONTROLE e API:
18.1. Configuração do PDV Sync Server para a loja via Postman
Para realizar as configurações para a utilização do PDV Sync no PDV Omnishop, é necessário realizar os cadastros abaixo através das APIs de Parâmetros.
O passo a passo do Postman se encontra no Google Drive no caminho: https://drive.google.com/drive/folders/1KriEZNs0ofg2uBF8u3TLniozko3IA063
Lá se encontra o arquivo com as Collections montadas para a configuração e com as variáveis para a utilização da criação de parâmetros.
1º - Criação do Inquilino
Para a criação do inquilino, utilizar o request 01. Criar Inquilino, informar os valores de acordo com as informações do cliente, realizar a autenticação e em seguida realizar o POST.
Após a criação, utilizar o valor do campo IdInquilino na variável para a configuração dos próximos passos.
2º - Criação dos Parâmetros Controle
Para a criação dos parâmetros do controle, basta apenas realizar a autenticação e realizar o POST.
3º - Criação dos Parâmetros Comercial
Para a criação dos parâmetros comerciais, basta apenas realizar a autenticação e realizar o POST.
4º - Criação do Parâmetro para a subida de Clientes
Para a criação do parâmetro de subida de cliente, basta apenas realizar a autenticação e realizar o POST.
Obs.: Para realizar esses procedimentos nos ambientes de desenvolvimento e homologação, seguir os mesmos passos acima, mas utilizar sua respectiva pasta (Passo a Passo - Homologação e Passo a Passo - Desenvolvimento).
Instalação dos Serviços UP, DOWN, CONTROLE e API:
...
...
Após os passos acima os serviços Api, Up, Down e Controle serão instalados e iniciados.
Desinstalação dos Serviços UP, DOWN, CONTROLE e API:
Para desinstalar os serviços acima basta acessar a pasta C:\PDVSync executar o arquivo “servicos-delete.bat”.
...