Árvore de páginas

Versões comparadas

Chave

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

...

Expandir
titleDefinições das propriedades do metadata
PropriedadeTipoDescriçãoObservação
ativarPDVSyncClientDownIntegradoBooleano

ativarPDVSyncClientUpIntegradoBooleano

endpointCreditoConsultaStringUtilizado para informar o endpoint da API do Processo Online Crédito Consulta
endpointCreditoConsumoStringUtilizado para informar o endpoint da API do Processo Online Crédito Consumo
endpointEstoqueConsultaStringUtilizado para informar o endpoint da API do Processo Online Estoque Saldo Consulta
endpointIdentificadorPdvStringUtilizado para informar o endpoint da API do Processo Online Identificador de Dispositivo PDV
endpointNotaEntradaEnvioStringUtilizado para informar o endpoint da API do Processo Online Nota de Entrada
endpointNotaSaidaEnvioStringUtilizado para informar o endpoint da API do Processo Online Nota de Saída Envio 
endpointPreVendaAtualizaStringUtilizado para informar o endpoint da API do Processo Online Pré Venda (Atualização de Situação)
endpointPreVendaConsultaListaPedidoStringUtilizado para informar o endpoint da API do Processo Online Pedido (Consulta Lista de Pedidos)
endpointPreVendaConsultaPedidoStringUtilizado para informar o endpoint da API do Processo Online Pedido (Consulta do Pedido completo)
endpointPreVendaEnvioStringUtilizado para informar o endpoint da API do Processo Online Pre Venda Envio
endpointReservaEstoqueEnvioStringUtilizado 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")
ipDinamicoBooleanoUtilizado para informar se será utilizado o IP dinâmico nas APIs do Retaguarda.
loginStringUsuário utilizado na autenticação da API do Retaguarda
maximoTentativasInteiro

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)
retaguardaStringUtilizado para informar qual Retaguarda está sendo utilizado pelo inquilino.Ex.(Winthor, Protheus, etc)
tempoMonitoraStatusInteiroUtilizado para informar o tempo de monitoramento de status.Tempo em segundos
tempoMonitoraStatusVendaInteiroUtilizado para informar o tempo de monitoramento de status de venda.
tipoAutenticacaoInteiroDetermina o tipo de autenticação utilizado na API do Retaguarda.Tipos definidos na seção 'Tipo autenticação'
urlBuscaIPDinamicoStringUtilizado para informar a API responsável por recuperar dinamicamente o IP das APIs do Retaguarda
urlRetaguardaStringUtilizado pra informar a URL das APIs do Retaguarda
versaoApiInteiroUtilizado para indicar a versão das APIs do POSH utilizada

Configurações de IP no metadata

...

Expandir
titleFluxo 1 - 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.

Expandir
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.