Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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
iddk1
Card
idcard1card2
labelVersão antiganova
Expandir
titleMetadata Json AntigoNovo
linenumberstrue
collapsetrue

{
    "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",
    "ipDinamico": false,
    "reservaEstoqueEnviologin": "string",
    "maximoTentativas": 0,
    "Retaguardapassword": "string",
    "tempoMonitoraStatusportaRetaguarda": 300,
    "token_typeprotocoloHttpRetaguarda": "string",
    "UrlBuscaIPDinamicoretaguarda": "string",
    "UrlRetaguardatempoMonitoraStatus": 0,
    "tempoMonitoraStatusVenda": 0,
    "tipoAutenticacao": 0,
    "urlBuscaIPDinamico": "string",
    "urlTokenurlRetaguarda": "string",
    "versaoApi": 0
}

Expandir
titleDefinições das propriedades do metadata antigoNovo
a Porta utilizada para acessar a API da Retaguarda  protocolo de comunicação utilizado na Utilizado pra informar a URL do RetaguardaEndpoint responsável por gerar o Token de autenticação da API
PropriedadeTipoDescriçãoObservação
ativarPDVSyncClientDownIntegradoBooleanoUtilizado para informar se será utilizado o Client DOWN integrado no PDV OmniDisponível apenas na V3. Valores = True ou False
ativarPDVSyncClientUpIntegradoBooleanoUtilizado para informar se será utilizado o Client UP integrado no PDV OmniDisponível apenas na V3. Valores = True ou False
endpointCreditoConsultaStringcreditoConsultastringUtilizado para informar o endpoint da API do Processo Online Crédito Consulta
creditoConsumoendpointCreditoConsumostringStringUtilizado para informar o endpoint da API do Processo Online Crédito Consumo
estoqueConsultaendpointEstoqueConsultastringStringUtilizado para informar o endpoint da API do Processo Online Estoque Saldo Consulta
identificadorPdvendpointIdentificadorPdvstringStringUtilizado para informar o endpoint da API do Processo Online Identificador de Dispositivo PDVipDinamicobooleanUtilizado para informar se será utilizado o IP dinâmico nas APIs do Retaguarda.
endpointNotaEntradaEnvioStringloginstringUsuário utilizado na autenticação da API do RetaguardanotaEntradaEnviostringUtilizado para informar o endpoint da API do Processo Online Nota de Entrada
notaSaidaEnvioendpointNotaSaidaEnviostringStringUtilizado para informar o endpoint da API do Processo Online Nota de Saída Envio 
passwordendpointNotificaRetaguardaNovaLojastringSenha utilizada na autenticação da API do RetaguardaPortaRetaguardaintegerStringUtilizado para informar o endpoint da API do Processo Online Notifica Retaguarda Nova Loja
endpointPreVendaAtualizaStringpreVendaAtualizastringUtilizado para informar o endpoint da API do Processo Online Pré Venda (Atualização de Situação)
preVendaConsultaListaPedidoendpointPreVendaConsultaListaPedidostringStringUtilizado para informar o endpoint da API do Processo Online Pedido (Consulta Lista de Pedidos)
preVendaConsultaPedidoendpointPreVendaConsultaPedidostringStringUtilizado para informar o endpoint da API do Processo Online Pedido (Consulta do Pedido completo)
preVendaEnvioendpointPreVendaEnviostringStringUtilizado para informar o endpoint da API do Processo Online Pre Venda Envio
ProtocoloHttpRetaguardaendpointReservaEstoqueEnviostringStringUtilizado para informar o endpoint da API do Processo Online Reserva de Estoque
endpointTokenStringEndpoint responsável por gerar o Token de autenticação da API do Retaguarda
horariosExecucaoVendaConsolidadaStringUtilizado para informar os horários que serão enviados as Vendas Consolidadas para os servidores do POSHCada hora deve ser enviada separadas por vírgula. Ex.("12,13,14,15,16")
ipDinamicoBooleanoEx.(http ou https)reservaEstoqueEnviostringUtilizado para informar o endpoint da API do Processo Online Reserva de Estoquese será utilizado o IP dinâmico nas APIs do Retaguarda.
loginStringUsuário utilizado na autenticação da API do Retaguarda
maximoTentativasInteiroQuantidade máxima de tentativas
passwordStringSenha utilizada na autenticação da API do Retaguarda
portaRetaguardaInteiroUtilizado para informar a Porta utilizada para acessar a API da RetaguardaMaior que 0
protocoloHttpRetaguardaStringUtilizado para informar o protocolo de comunicação utilizado na API do RetaguardaEx.(http ou https)
retaguardaStringRetaguardastringUtilizado para informar qual Retaguarda está sendo utilizado pelo inquilino.Ex.(Winthor, Protheus, etc)
tempoMonitoraStatusintegerInteiroUtilizado para informar o tempo de monitoramento de status.Tempo em segundos
tempoMonitoraStatusVendaInteiroUtilizado para informar o tempo de monitoramento de status de venda.
token_typetipoAutenticacaostringInteiroDetermina o tipo de autenticação utilizado na API do Retaguarda.EX.(Basic,Bearer)Tipos definidos na seção 'Tipos autenticações'
urlBuscaIPDinamicoStringUtilizado para informar a API responsável por recuperar dinamicamente o IP UrlBuscaIPDinamicostring das APIs do Retaguarda
UrlRetaguardaurlRetaguardastringStringUtilizado pra informar a URL das APIs urlTokenstring do Retaguarda
versaoApiInteiroUtilizado para indicar a versão das APIs do POSH utilizada
Expandir
titleTipos autenticações
CódigoTipo
0NoAuth
1Basic
2Bearer
Card
idcard2card1
labelVersão novaantiga
Expandir
titleMetadata Json NovoAntigo
linenumberstrue
collapsetrue

{
    "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",
    "ipDinamico": false,
    "loginreservaEstoqueEnvio": "string",
    "maximoTentativasRetaguarda": 0,
    "password ": "string",
    "portaRetaguardatempoMonitoraStatus": 030,
    "protocoloHttpRetaguardatoken_type": "string",
    "retaguardaUrlBuscaIPDinamico": "string",
    "tempoMonitoraStatusUrlRetaguarda": 0,
    "tempoMonitoraStatusVenda ": 0,
    "tipoAutenticacao": 0,
    "urlBuscaIPDinamico": "string",
    "urlRetaguardaurlToken": "string",
    "versaoApi": 0
}

Bearer
Expandir
titleDefinições das propriedades do metadata Novoantigo
CódigoTipo
0Basic
1
Booleano se será utilizado Client UP integrado no PDV Omni o endpoint da API do Processo Online Notifica Retaguarda Nova Loja endpoint da API do Processo Online Reserva de EstoqueUtilizado para informar Utilizado para informar a API responsável por recuperar dinamicamente o IP
PropriedadeTipoDescriçãoObservação
ativarPDVSyncClientDownIntegradoBooleanoUtilizado para informar se será utilizado o Client DOWN integrado no PDV OmniDisponível apenas na V3. Valores = True ou False
ativarPDVSyncClientUpIntegrado
creditoConsultastring
Utilizado para informar
o
Disponível apenas na V3. Valores = True ou False
endpointCreditoConsultaStringUtilizado para informar o endpoint da API do Processo Online Crédito Consulta
endpointCreditoConsumocreditoConsumoStringstringUtilizado para informar o endpoint da API do Processo Online Crédito Consumo
endpointEstoqueConsultaestoqueConsultaStringstringUtilizado para informar o endpoint da API do Processo Online Estoque Saldo Consulta
endpointIdentificadorPdvidentificadorPdvStringstringUtilizado para informar o endpoint da API do Processo Online Identificador de Dispositivo PDV
ipDinamicobooleanUtilizado para informar se será utilizado o IP dinâmico nas APIs do Retaguarda.
loginstringUsuário utilizado na autenticação da API do Retaguarda
notaEntradaEnviostringendpointNotaEntradaEnvioStringUtilizado para informar o endpoint da API do Processo Online Nota de Entrada
endpointNotaSaidaEnvionotaSaidaEnvioStringstringUtilizado para informar o endpoint da API do Processo Online Nota de Saída Envio endpointNotificaRetaguardaNovaLoja
passwordstringSenha utilizada na autenticação da API do Retaguarda
PortaRetaguardaintegerStringUtilizado para informar a Porta utilizada para acessar a API da Retaguarda
preVendaAtualizastringendpointPreVendaAtualizaStringUtilizado para informar o endpoint da API do Processo Online Pré Venda (Atualização de Situação)
endpointPreVendaConsultaListaPedidopreVendaConsultaListaPedidoStringstringUtilizado para informar o endpoint da API do Processo Online Pedido (Consulta Lista de Pedidos)
endpointPreVendaConsultaPedidopreVendaConsultaPedidoStringstringUtilizado para informar o endpoint da API do Processo Online Pedido (Consulta do Pedido completo)
endpointPreVendaEnviopreVendaEnvioStringstringUtilizado para informar o endpoint da API do Processo Online Pre Venda Envio
endpointReservaEstoqueEnvioProtocoloHttpRetaguardaStringstringUtilizado para informar o endpointTokenStringEndpoint responsável por gerar o Token de autenticação da API do Retaguarda
horariosExecucaoVendaConsolidadaStringUtilizado para informar os horários que serão enviados as Vendas Consolidadas para os servidores do POSHCada hora deve ser enviada separadas por vírgula. Ex.("12,13,14,15,16")
ipDinamicoBooleanoUtilizado para informar se será utilizado o IP dinâmico nas APIs do Retaguarda.loginStringUsuário utilizado na autenticação da API do RetaguardamaximoTentativasInteiroQuantidade máxima de tentativas
protocolo de comunicação utilizado na API do RetaguardaEx.(http ou https)
reservaEstoqueEnviostringUtilizado para informar o endpoint da API do Processo Online Reserva de Estoque
RetaguardastringUtilizado para informar
passwordStringSenha utilizada na autenticação da API do Retaguarda
portaRetaguardaInteiroUtilizado para informar a Porta utilizada para acessar a API da RetaguardaMaior que 0
protocoloHttpRetaguardaStringUtilizado para informar o protocolo de comunicação utilizado na API do RetaguardaEx.(http ou https)
retaguardaString qual Retaguarda está sendo utilizado pelo inquilino.Ex.(Winthor, Protheus, etc)
tempoMonitoraStatusInteirointegerUtilizado para informar o tempo de monitoramento de status.Tempo em segundos
tempoMonitoraStatusVendaInteiro
Utilizado para informar o tempo de monitoramento de status de venda.
tipoAutenticacaotoken_typeInteirostringDetermina o tipo de autenticação utilizado na API do Retaguarda.Tipos definidos na seção 'Tipos autenticações'EX.(Basic,Bearer)
UrlBuscaIPDinamicostringUtilizado pra informar a URL urlBuscaIPDinamicoString das APIs do Retaguarda
urlRetaguardaUrlRetaguardaStringstringUtilizado pra informar a URL das APIs do Retaguarda
urlTokenstringEndpoint responsável por gerar o Token de autenticação da API do Retaguarda
versaoApiInteiroUtilizado para indicar a versão das APIs do POSH utilizada
Expandir
titleTipos autenticações

Extrair

Configurações de IP no metadata

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

Deck of Cards
idfluxoIp
Card
labelFluxo 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
titleCampos metadata
linenumberstrue
{
    "IpDinamico": false,
    "UrlRetaguarda": "http://{IP}:{Porta}"
}

Descrição dos campos

PropriedadeTipoDescriçãoObservação
IpDinamicoBoolIndica se utiliza o IP Dinâmico.Obrigatório
UrlRetaguardaStringURL que será feita a consulta dos dados na retaguardaObrigató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
labelFluxo IP dinâmico
titleFluxo 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
titleCampos metadata
linenumberstrue
{
    "ipDinamico": true,
    "urlBuscaIPDinamico": "http://{ip}/api/v1/client/ip",
    "protocoloHttpRetaguarda": "http",
    "portaRetaguarda": 0
}

Descrição dos campos

PropriedadeTipoDescriçãoObservação
IpDinamicoBoolIndica se utiliza o IP Dinâmico.Obrigatório
UrlBuscaIPDinamicoStringURL que será feita a consulta do IPObrigatório
ProtocoloHttpRetaguardaStringProtocolo utilizado para a comunicação com a retaguardaObrigatório
PortaRetaguardaIntPorta utlizada para comunicação com a retaguardaOpcional


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.

...