...

Nessa seção teremos as informações de todas as propriedades que podem ser enviadas no metadata e também o json com todas as propriedades.

Deck of Cards

id	dk1

Card

id	card1card2
label	Versão antiganova

Expandir

title	Metadata Json AntigoNovo
linenumbers	true
collapse	true

{
"creditoConsultaativarPDVSyncClientDownIntegrado": false,
"stringativarPDVSyncClientUpIntegrado": false,
"creditoConsumoendpointCreditoConsulta": "string",
"estoqueConsultaendpointCreditoConsumo": "string",
"identificadorPdvendpointEstoqueConsulta": "string",
"ipDinamicoendpointIdentificadorPdv": false"string",
"loginendpointNotaEntradaEnvio": "string",
"notaEntradaEnvioendpointNotaSaidaEnvio": "string",
"notaSaidaEnvioendpointNotificaRetaguardaNovaLoja": "string",
"passwordendpointPreVendaAtualiza": "string",
"PortaRetaguardaendpointPreVendaConsultaListaPedido": 88"string",
"preVendaAtualizaendpointPreVendaConsultaPedido": "string",
"preVendaConsultaListaPedidoendpointPreVendaEnvio": "string",
"preVendaConsultaPedidoendpointReservaEstoqueEnvio": "string",
"preVendaEnvioendpointToken": "string",
"ProtocoloHttpRetaguardahorariosExecucaoVendaConsolidada": "string",
"reservaEstoqueEnvioipDinamico": false,
"login": "string",
"maximoTentativas": 0,
"Retaguardapassword": "string",
"tempoMonitoraStatusportaRetaguarda": 300,
"token_typeprotocoloHttpRetaguarda": "string",
"UrlBuscaIPDinamicoretaguarda": "string",
"tempoMonitoraStatus": 0,
"tempoMonitoraStatusVenda": 0,
"tipoAutenticacao": 0,
"UrlRetaguardaurlBuscaIPDinamico": "string",
"urlTokenurlRetaguarda": "string",
"versaoApi": 0
}

Expandir

title	Definições das propriedades do metadata antigoNovo

se será utilizado IP dinâmico nas APIs do Retaguarda.Utilizado para informar o a Porta utilizada para acessar a API da Retaguarda o protocolo de comunicação utilizado na API do RetaguardaUtilizado pra informar a URL urlToken

Propriedade	Tipo	Descrição	Observação
ativarPDVSyncClientDownIntegrado	Booleano	Utilizado para informar se será utilizado o Client DOWN integrado no PDV Omni	Disponível apenas na V3. Valores = True ou False
ativarPDVSyncClientUpIntegrado	Booleano	Utilizado para informar se será utilizado o Client UP integrado no PDV Omni	Disponível apenas na V3. Valores = True ou False
endpointCreditoConsulta	String	creditoConsulta	string	Utilizado para informar o endpoint da API do Processo Online Crédito Consulta
creditoConsumoendpointCreditoConsumo	stringString	Utilizado para informar o endpoint da API do Processo Online Crédito Consumo
estoqueConsultaendpointEstoqueConsulta	stringString	Utilizado para informar o endpoint da API do Processo Online Estoque Saldo Consulta
identificadorPdvendpointIdentificadorPdv	stringString	Utilizado para informar o endpoint da API do Processo Online Identificador de Dispositivo PDV
ipDinamicoendpointNotaEntradaEnvio	booleanString	Utilizado para informar	o	login	string	Usuário utilizado na autenticação da API do Retaguarda	notaEntradaEnvio	string	endpoint da API do Processo Online Nota de Entrada
notaSaidaEnvioendpointNotaSaidaEnvio	stringString	Utilizado para informar o endpoint da API do Processo Online Nota de Saída Envio
passwordendpointNotificaRetaguardaNovaLoja	string	Senha utilizada na autenticação da API do Retaguarda	PortaRetaguarda	integer	String	Utilizado para informar	o endpoint da API do Processo Online Notifica Retaguarda Nova Loja
endpointPreVendaAtualiza	String	preVendaAtualiza	string	Utilizado para informar o endpoint da API do Processo Online Pré Venda (Atualização de Situação)
preVendaConsultaListaPedidoendpointPreVendaConsultaListaPedido	stringString	Utilizado para informar o endpoint da API do Processo Online Pedido (Consulta Lista de Pedidos)
preVendaConsultaPedidoendpointPreVendaConsultaPedido	stringString	Utilizado para informar o endpoint da API do Processo Online Pedido (Consulta do Pedido completo)
preVendaEnvioendpointPreVendaEnvio	stringString	Utilizado para informar o endpoint da API do Processo Online Pre Venda	Envio
ProtocoloHttpRetaguardaendpointReservaEstoqueEnvio	stringString	Utilizado para informar	Ex.(http ou https)	reservaEstoqueEnvio	string	Utilizado para informar o endpoint da API do Processo Online Reserva de Estoque	o endpoint da API do Processo Online Reserva de Estoque
endpointToken	String	Endpoint responsável por gerar o Token de autenticação da API do Retaguarda
horariosExecucaoVendaConsolidada	String	Utilizado para informar os horários que serão enviados as Vendas Consolidadas para os servidores do POSH	Cada hora deve ser enviada separadas por vírgula. Ex.("12,13,14,15,16")
ipDinamico	Booleano	Utilizado para informar se será utilizado o IP dinâmico nas APIs do Retaguarda.
login	String	Usuário utilizado na autenticação da API do Retaguarda
maximoTentativas	Inteiro	Quantidade máxima de tentativas
password	String	Senha utilizada na autenticação da API do Retaguarda
portaRetaguarda	Inteiro	Utilizado para informar a Porta utilizada para acessar a API da Retaguarda	Maior que 0
protocoloHttpRetaguarda	String	Utilizado para informar o protocolo de comunicação utilizado na API do Retaguarda	Ex.(http ou https)
retaguarda	String	Retaguarda	string	Utilizado para informar qual Retaguarda está sendo utilizado pelo inquilino.	Ex.(Winthor, Protheus, etc)
tempoMonitoraStatus	integerInteiro	Utilizado para informar o tempo de monitoramento de status.	Tempo em segundos
tempoMonitoraStatusVenda	Inteiro	Utilizado para informar o tempo de monitoramento de status de venda.
token_typetipoAutenticacao	stringInteiro	Determina o tipo de autenticação utilizado na API do Retaguarda.	EX.(Basic,Bearer)	Tipos definidos na seção 'Tipos autenticações'
urlBuscaIPDinamico	String	Utilizado para informar a API responsável por recuperar dinamicamente o IP	UrlBuscaIPDinamico	string	das APIs do Retaguarda
UrlRetaguardaurlRetaguarda	stringString	Utilizado pra informar a URL das APIs do Retaguarda		string	Endpoint responsável por gerar o Token de autenticação da API do Retaguarda
versaoApi	Inteiro	Utilizado para indicar a versão das APIs do POSH utilizada

Expandir

title	Tipos autenticações

Código	Tipo
0	NoAuth
1	Basic
2	Bearer

Card

id	card2card1
label	Versão novaantiga

Expandir

title	Metadata Json NovoAntigo
linenumbers	true
collapse	true

{
"ativarPDVSyncClientDownIntegradocreditoConsulta": false,
"ativarPDVSyncClientUpIntegradostring": false,
"endpointCreditoConsultacreditoConsumo": "string",
"endpointCreditoConsumoestoqueConsulta": "string",
"endpointEstoqueConsultaidentificadorPdv": "string",
"endpointIdentificadorPdvipDinamico": "string"false,
"endpointNotaEntradaEnviologin": "string",
"endpointNotaSaidaEnvionotaEntradaEnvio": "string",
"EndpointNotificaRetaguardaNovaLojanotaSaidaEnvio": "string",
"endpointPreVendaAtualizapassword": "string",
"endpointPreVendaConsultaListaPedidoPortaRetaguarda": "string"88,
"endpointPreVendaConsultaPedidopreVendaAtualiza": "string",
"endpointPreVendaEnviopreVendaConsultaListaPedido": "string",
"endpointReservaEstoqueEnviopreVendaConsultaPedido": "string",
"endpointTokenpreVendaEnvio": "string",
"horariosExecucaoVendaConsolidadaProtocoloHttpRetaguarda": "string",
"ipDinamicoreservaEstoqueEnvio": false,
"login ": "string",
"maximoTentativasRetaguarda": 0,
"password": "string",
"portaRetaguardatempoMonitoraStatus": 030,
"protocoloHttpRetaguardatoken_type": "string",
"retaguardaUrlBuscaIPDinamico": "string",
"tempoMonitoraStatus": 0,
"tempoMonitoraStatusVenda": 0,
"tipoAutenticacao": 0,
"urlBuscaIPDinamico": "UrlRetaguarda": "string",
"urlRetaguardaurlToken": "string",
"versaoApi": 0
}

Expandir

title	Definições das propriedades do metadata Novoantigo

o endpoint da API do Processo Online Notifica Retaguarda Nova Loja endpoint da API do Processo Online Reserva de EstoqueUtilizado para informar a API responsável por recuperar dinamicamente o IP

Propriedade	Tipo	Descrição	Observação
ativarPDVSyncClientDownIntegrado	Booleano	Utilizado para informar se será utilizado o Client DOWN integrado no PDV Omni	Disponível apenas na V3. Valores = True ou False
ativarPDVSyncClientUpIntegrado	Booleano	Utilizado para informar se será utilizado o Client UP integrado no PDV Omni	Disponível apenas na V3. Valores = True ou False
creditoConsulta	string	endpointCreditoConsulta	String	Utilizado para informar o endpoint da API do Processo Online Crédito Consulta
endpointCreditoConsumocreditoConsumo	Stringstring	Utilizado para informar o endpoint da API do Processo Online Crédito Consumo
endpointEstoqueConsultaestoqueConsulta	Stringstring	Utilizado para informar o endpoint da API do Processo Online Estoque Saldo Consulta
endpointIdentificadorPdvidentificadorPdv	Stringstring	Utilizado para informar o endpoint da API do Processo Online Identificador de Dispositivo PDV
ipDinamico	boolean	Utilizado para informar se será utilizado o IP dinâmico nas APIs do Retaguarda.
login	string	Usuário utilizado na autenticação da API do Retaguarda
notaEntradaEnvio	string	endpointNotaEntradaEnvio	String	Utilizado para informar o endpoint da API do Processo Online Nota de Entrada
endpointNotaSaidaEnvionotaSaidaEnvio	Stringstring	Utilizado para informar o endpoint da API do Processo Online Nota de Saída Envio	EndpointNotificaRetaguardaNovaLoja
password	string	Senha utilizada na autenticação da API do Retaguarda
PortaRetaguarda	integerString	Utilizado para informar a Porta utilizada para acessar a API da Retaguarda
preVendaAtualiza	string	endpointPreVendaAtualiza	String	Utilizado para informar o endpoint da API do Processo Online Pré Venda (Atualização de Situação)
endpointPreVendaConsultaListaPedidopreVendaConsultaListaPedido	Stringstring	Utilizado para informar o endpoint da API do Processo Online Pedido (Consulta Lista de Pedidos)
endpointPreVendaConsultaPedidopreVendaConsultaPedido	Stringstring	Utilizado para informar o endpoint da API do Processo Online Pedido (Consulta do Pedido completo)
endpointPreVendaEnviopreVendaEnvio	Stringstring	Utilizado para informar o endpoint da API do Processo Online Pre Venda Envio
endpointReservaEstoqueEnvioProtocoloHttpRetaguarda	Stringstring	Utilizado para informar o	endpointToken	String	Endpoint responsável por gerar o Token de autenticação da API do Retaguarda
horariosExecucaoVendaConsolidada	String	Utilizado para informar os horários que serão enviados as Vendas Consolidadas para os servidores do POSH	Cada hora deve ser enviada separadas por vírgula. Ex.("12,13,14,15,16")
ipDinamico	Booleano	Utilizado para informar se será utilizado o IP dinâmico nas APIs do Retaguarda.	login	String	Usuário utilizado na autenticação da API do Retaguarda	maximoTentativas	Inteiro	Quantidade máxima de tentativas
protocolo de comunicação utilizado na API do Retaguarda	Ex.(http ou https)
reservaEstoqueEnvio	string	Utilizado para informar o endpoint da API do Processo Online Reserva de Estoque
Retaguarda	string
password	String	Senha utilizada na autenticação da API do Retaguarda
portaRetaguarda	Inteiro	Utilizado para informar a Porta utilizada para acessar a API da Retaguarda	Maior que 0
protocoloHttpRetaguarda	String	Utilizado para informar o protocolo de comunicação utilizado na API do Retaguarda	Ex.(http ou https)
retaguarda	String	Utilizado para informar qual Retaguarda está sendo utilizado pelo inquilino.	Ex.(Winthor, Protheus, etc)
tempoMonitoraStatus	Inteirointeger	Utilizado para informar o tempo de monitoramento de status.	Tempo em segundos
tempoMonitoraStatusVendaInteiro		Utilizado para informar o tempo de monitoramento de status de venda.
tipoAutenticacaotoken_type	Inteirostring	Determina o tipo de autenticação utilizado na API do Retaguarda.	Tipos definidos na seção 'Tipos autenticações'	EX.(Basic,Bearer)
UrlBuscaIPDinamico	string	Utilizado pra informar a URL	urlBuscaIPDinamico	String	das APIs do Retaguarda
urlRetaguardaUrlRetaguarda	Stringstring	Utilizado pra informar a URL das APIs do Retaguarda
urlToken	string	Endpoint responsável por gerar o Token de autenticação da API do Retaguarda
versaoApi	Inteiro	Utilizado para indicar a versão das APIs do POSH utilizada

Expandir

title	Tipos autenticações

Código

Tipo

0

Basic

1

Bearer

Extrair

Configurações de IP no metadata

Abaixo temos as definições dos fluxos de IP Fixo e IP Dinâmico

Documentação de apoio da engenharia: Arquitetura e Definições

Deck of Cards

id	fluxoIp

Card

label	Fluxo IP fixo

O fluxo "IP Fixo" funcionava a partir da url que era cadastrada com o inquilino no campo "ConnectionString", porém, com a implementação do fluxo do IP Dinâmico, este fluxo sofreu algumas alterações.

Com as novas implementações, o campo obrigatório para que esse fluxo funcione é o "UrlRetaguarda" presente no campo metadata do inquilino.

Aqui está um exemplo de como o metadata deve estar para que o fluxo "IP Fixo" funcione corretamente.

Bloco de código

title	Campos metadata
linenumbers	true

{
    "IpDinamico": false,
    "UrlRetaguarda": "http://{IP}:{Porta}"
}

Descrição dos campos

Propriedade	Tipo	Descrição	Observação
IpDinamico	Bool	Indica se utiliza o IP Dinâmico.	Obrigatório
UrlRetaguarda	String	URL que será feita a consulta dos dados na retaguarda	Obrigatório

Validações

Nesse fluxo a única validação imposta é a propriedade "UrlRetaguarda" que deve estar preenchida, caso ocorra o envio dela vázia ("") ou nula, uma mensagem de erro será retornada. Vide exemplo de retorno do erro.

Caso todas a validações estejam corretas, a requisição seguirá com seu fluxo normalmente, realizando as solicitações na URL enviada.

Card

label	Fluxo IP dinâmico
title	Fluxo 2 - IP Dinâmico

O fluxo "IP Dinâmico" é o fluxo responsável por verificar se o IP da retaguarda sofreu alguma alteração e realizar a busca do novo IP para as novas requisições.

Algumas propriedades são obrigatórias no metadata para que esse fluxo funcione corretamente

Segue um exemplo de como deve ser o metadata nesse fluxo e a definição de cada propriedade

Bloco de código

title	Campos metadata
linenumbers	true

{
    "ipDinamico": true,
    "urlBuscaIPDinamico": "http://{ip}/api/v1/client/ip",
    "protocoloHttpRetaguarda": "http",
    "portaRetaguarda": 0
}

Descrição dos campos

Propriedade	Tipo	Descrição	Observação
IpDinamico	Bool	Indica se utiliza o IP Dinâmico.	Obrigatório
UrlBuscaIPDinamico	String	URL que será feita a consulta do IP	Obrigatório
ProtocoloHttpRetaguarda	String	Protocolo utilizado para a comunicação com a retaguarda	Obrigatório
PortaRetaguarda	Int	Porta utlizada para comunicação com a retaguarda	Opcional

Validações

Nesse fluxo caso ocorra o envio de alguma propriedade obrigatória como vazia ou nula, uma mensagem de erro será retornada. Vide exemplo de retorno do erro.

...

Árvore de páginas

Versões comparadas

Versão antiga 14

Nova versão Atual

Chave

Configurações de IP no metadata

Descrição dos campos

Validações

Descrição dos campos

Validações

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 14

Nova versão Atual

Chave

Configurações de IP no metadata

Descrição dos campos

Validações

Descrição dos campos

Validações