...
...
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:
Incluir Authorization OAuth2.0 conforme token:
URL: https://pdvsync.varejo.totvs.com.br/controle/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 "1000,
"tempoChamada": 2000,
"tempoExpurgoLogs": 365,Inativo(0)", "Ativo(1)", "Pendente(2)"
"envioDadoTipotipoDado": "0", → tipo de envio do dado para a retaguarda em caso de retornos
{
"envioDadocodigoTipo": "", → dependendo do tipo de envio preencher a informação relevante.1,
"connectionStringdescricaoTipo": "Loja", → está relacionado com a informação anterior.
"lotetipoUtilizador": " 0" → não utilizado ainda, utilizar 0 por enquanto,,/*ClienteDown = 0, Server = 1, ClienteUp = 2, ClienteOnLine = 3 */
"IdInquilino": "" → O código do IdInquilino é fornecido automaticamente pelo Totvs RAC após o envio do serviço.
}
...
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 |
{
"success": true,
"message": "",
"data": {
"idIdentificacaoExterna":
"nome": "
"situacao": 1,
"envioDadoTipo": 0,
"envioDado": "",
"connectionString": "",
"clientId": null,
"clientSecret": null,
"usuario": null,
"senha": null,
"tokenUrl": null,
"id": "", → código gerado pelo TOTVS RAC
"idInquilino": null,
"dataAtualizacao": "",
"dataCadastro": "",
"_expandables": []
}
}
2º - Cadastrar os parâmetros.
Post
{
"idInquilino": "", → O código do IdInquilino conforme usado na API de inquilino.
"QuantidadeRegistros": 100,
"TempoChamada": 2,
"TempoExpurgoLogs": 130000,
"TipoDado": {
"CodigoTipo": 14,
"DescricaoTipo": "Estoque",
"TipoUtilizador": 1
},
"TipoProcesso": 1
}
Lista de Parâmetros:
codigoTipo | descricaoTipo | tipo |
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": [{
"success": true,
"message": "",
"data": [
{
"tipoProcesso": 1,
"quantidadeRegistros": 10000,
1
"tempoChamada": 2.0],
"tempoExpurgoLogsidInquilino": 130000.0,
"tipoDado": {" /*O código do IdInquilino conforme retornado no email.*/
}
Response:
{
"success": true,
"message": "",
"data": {
"loteOrigem": "20221004175001554",
"mensagem": null,
"id": null,
"codigoTipo": 14,
"descricaoTipo": "Estoque",
"tipoUtilizador": 1,
"tipoProcessostatus": 0,
"_expandablestipoLote": []
},6
],
"id": "DLoi3SX5HDoPOcDlyf0m",
"idInquilino": "",
"dataAtualizacao": "2022-0810-05T1504T17:1050:2101.604886Z6441804Z",
"dataCadastro": "2022-0810-05T1504T17:1050:2101.604888Z6442468Z",
"_expandables": []
}
}
3º - Abrir Lote com Parâmetro 06 - Compartilhamento
Incluir Authorization OAuth2.0 conforme token:
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
[
Post
{
"statusrazaoSocial": 0" ",
"tipoLotenomeFantasia": [
6
]" ",
"idInquilinocnpj": " ",
}
Response:
{
/*obrigatório e valido - 14 caracteres*/
"successinscricaoEstadual": true," ", /*obrigatório - 2 e 14 caracteres*/
"messageinscricaoMunicipal": " ", /*obrigatório - até 15 caracteres*/
"dataendereco": {" ",
"loteOrigemnumero": " 20221004175001554 ",
"mensagemcomplemento": null" ",
"statusbairro": 0" ",
"tipoLotecidade": [
6
]" ",
"idestado": " DLoi3SX5HDoPOcDlyf0m ",
"idInquilinosiglaUf": " ",
"dataAtualizacaocodigoUFIBGE": " 2022-10-04T17:50:01.6441804Z ",
/*obrigatório - 2 caracteres*/
"dataCadastrocodigoMunicipioIbge": " 2022-10-04T17:50:01.6442468Z",", /*obrigatório - 7 caracteres*/
"_expandables": []
}
}
4º - Criar Compartilhamento
Post
[
{
"IdRetaguardaLojacep": "", /*obrigatorio*/
"telefone": "", /*obrigatório - 6 e 14 caracteres*/
"IdRetaguardacodigoIdentificacaoLoja": "32796d0b-8399-490e-b972-1db212c514fa",
"IdProprietariomodeloFiscal": "32796d0b-8399-490e-b972-1db212c514fa"0,
"IdInquilinoregimeTributario": ""1,
"NomeCompartilhamentorede": "PDV Master", /*obrigatório*/
"NivelnumeroLoja": "0",
"IdRetaguardaPaiidRetaguardaRede": "",
"loteOrigemcodigoMaster": " 20221004175001554 "
},
{
"IdRetaguardaLojanomeMaster": " 3f054f05-ee67-407b-935d-9db0fc5e7c58 ",
"IdRetaguardasituacao": "3f054f05-ee67-407b-935d-9db0fc5e7c58"1,
"IdProprietarioidInquilino": " 3f054f05-ee67-407b-935d-9db0fc5e7c58 ",
/*Gerado no passo 1*/
"IdInquilinoidRetaguarda": "3 ", /*código da loja na retaguarda*/
"NomeCompartilhamentoidProprietario": " PDV Loja ", /*compartilhamento da loja*/
"Nivel": 1,
"IdRetaguardaPai": "",
"loteOrigem": " 20221004175001554"" /*Gerado no passo 3*/
}
]Response:
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º - Abrir Lote com Parâmetro 06 - Compartilhamento
Incluir Authorization OAuth2.0 conforme retornado no email.
endpoint: https://pdvsync.varejo.totvs.com.br/controle/api/retaguarda/inquilinolotesexternos
Post
{
"status": "InicioEnvio",
"tipoLote": [
6
],
"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": []
}
}
7º - Criar Compartilhamento
endpoint: https://pdvsync-core-controle-prd-q6yz66olca-rj.a.run.app/api/retaguarda/compartilhamentos
Post
[
{
"IdRetaguardaLoja": "",
"IdRetaguarda": "32796d0b-8399-490e-b972-1db212c514fa",
"IdProprietario": "32796d0b-8399-490e-b972-1db212c514fa",
"IdInquilino": "",
"NomeCompartilhamento": "PDV Master",
"Nivel": 0,
"IdRetaguardaPai": "",
"loteOrigem": "20221004175001554"
},
{
"IdRetaguardaLoja": {
"success": true,
"message": "compartilhamento inserido com sucesso: [{\"IdRetaguarda\":\"32796d0b-8399-490e-b972-1db212c514fa\",\"IdProprietario\":\"32796d0b-8399-490e-b972-1db212c514fa\",\"NomeCompartilhamento\":\"PDV Master\",\"Nivel\":0,\"IdRetaguardaPai\":\"\",\"LoteOrigem\":\"20221004175001554\",\"Lote\":null,\"IdRetaguardaLoja\":\"\",\"Id\":null,\"IdInquilino\":\"\",\"DataAtualizacao\":\"0001-01-01T00:00:00\",\"DataCadastro\":\"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
}
5º - Fechar o Lote
https:/pdvsync-core-controle-prd-q6yz66olca-rj.a.run.app/api/retaguarda/inquilinolotesexternos/{idInquilino}/{loteOrigem}
...
"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: [{\"IdRetaguarda\":\"32796d0b-8399-490e-b972-1db212c514fa\",\"IdProprietario\":\"32796d0b-8399-490e-b972-1db212c514fa\",\"NomeCompartilhamento\":\"PDV Master\",\"Nivel\":0,\"IdRetaguardaPai\":\"\",\"LoteOrigem\":\"20221004175001554\",\"Lote\":null,\"IdRetaguardaLoja\":\"\",\"Id\":null,\"IdInquilino\":\"\",\"DataAtualizacao\":\"0001-01-01T00:00:00\",\"DataCadastro\":\"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:/
6º - Abrir lote com Parâmetro 01 - Loja
Post
{
"status": 0,
"tipoLote": [
1
],
"idInquilino": "",
}
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,
"idInquilino": " ", - Gerado no passo 1
"idRetaguarda": "3 ", - Gerado no passo 4
"idProprietario": " ",- Gerado no passo 4
"loteOrigem": " " - Gerado no passo 6
}
]
8º - Fechar lote de loja
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 06anterior
9º - Cadastrar os parâmetros comerciais para a consulta de operações de vendas e caixa
...
[
{
"idInquilino": "", - /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 1,
"tipo": 1,
"valor": "10"
},
{
"idInquilino": "",
"dataAtualizacao /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 2,
"tipo": 2,
"valor": "10"
},
{
"idInquilino": "", /*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": "", /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 4,
"tipo": 4,
"valor": "10"
},
{
"idInquilino": "", /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"codigo": 4,
"tipo": 4,
"valor": "10"
},
{
"idInquilino": "",
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 5,
"tipo": 0,
"valor": "https://pdvsync-core-fila-prd-q6yz66olca-rj.a.run.app/api/stub/historicovenda"
}
Serviços Clients
...
Instalação dos Serviços UP, DOWN, CONTROLE e API:
Desinstalação dos Serviços UP, DOWN, CONTROLE e API:
...
",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"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).