Histórico da Página

Descrição

A api de StatusServicos foi criada com o intuito de que os serviços que utilizam o PDVSync possam sinalizar que estão funcionando.

Exemplo de funcionamento

O PDVSync.Client.Down envia o status a cada 30 minutos
Caso não haja o Status ele irá criar na tabela StatusServico no PDVSync.Core.Controle
Caso já exista o dado ele irá atualizar

Definição dos endpoints

...

POST

URL: /api/pdvsyncclient/v2/statusservico

Exemplo de body da requisição

{
    "idInquilino": "IdInquilinoTeste",
    "aplicacao":"AplicacaoTeste",
    "retaguarda": "RetaguardaTeste",
    "servico": "ServicoTeste",
    "idLojaRetaguarda": "IdLojaRetaguardaTeste",
    "dispositivo": "DispositivoTeste",
    "idDevice": "IdDeviceTeste",
    "status": "StatusTeste",
    "dataServidor": "2023-11-22T13:00:00.000Z"
}

Definição dos campos de requisição

Campo	Tipo	Descrição	Observações
idInquilino	string	Id do inquilino que enviou o status	Não Nulo
aplicacao	sring	Aplicação utilizada ex.: WSH/PDVSync	Não nulo
retaguarda	string	Retaguarda utilizada pelo serviço ex.: Winthor/Protheus	Não nulo
servico	string	Serviço que enviou o status ex.: PDVSync.Client.Down/PDVSync.Client.UP/Client.WSH/ClientProtheus	Não nulo
idLojaRetaguarda	string	Id retaguarda da loja que está utilizando o serviço	Não nulo
dispositivo	string	Dispositivo que está utilizando o serviço	Nullable
idDevice	string	Id do dispoisitivo que está utilizando o serviço	Nullable
status	string	Status do serviço ex.: Ativo/Inativo	Não nulo
dataServidor	Timestamp	Data que o serviço enviou o status OBS: Enviar a data com timezone	Não nulo

Retornos

HTTP 200 - Ok

{
  "success": true,
  "message": "",
  "data": {
  "aplicacao": "AplicacaoTeste",
  "retaguarda": "RetaguardaTeste",
  "servico": "ServicoTeste",
  "idLojaRetaguarda": "IdLojaRetaguardaTeste",
  "dispositivo": "DispositivoTeste",
  "idDevice": "IdDeviceTeste",
  "status": "StatusTeste",
  "dataServidor": "2023-11-22T13:00:00Z",
  "idInquilino": "IdInquilinoTeste",
  "dataAtualizacao": "2023-11-22T15:24:38.1057876Z",
  "dataCadastro": "2023-11-22T15:24:38.105787Z",
  "id": "19",
  "_expandables": []
  }
}

HTTP 400 - Bad request (Retorno recebido quando um campo obrigatório não é enviado)

{
  "code": "",
  "message": "",
  "detailedMessage": "",
  "helpUrl": "",
  "details": [
  {
  "guid": "23d3d6cd-084d-413a-8b1f-f596df5a9fe6",
  "code": "CQIFlap.Pber.Pbagebyr.Qbznva.Ragvgvrf.FgnghfFreivpb.FgnghfFreivpb+Reebe.5",
  "message": "O Status deve conter um status.",
  "detailedMessage": "StatusShouldHaveStatusSpecification"
  }
  ]
}

...

GET

URL: api/pdvsyncclient/v2/statusservico

Definição dos campos de requisição

OBS: Os campos abaixo devem ser enviados como parâmetro no header da requisição

Campo	Tipo	Descrição	Observações
idInquilino	string	Id do inquilino	Nullable
aplicacao	string	Aplicação que enviou o status ex.: WSH/PDVSync	Nullable
idLojaRetaguarda	string	Id Retaguarda da loja que enviou o status	Nullable
servico	string	Serviço que enviou o status ex.: PDVSync.Client.Down/PDVSync.Client.UP/Client.WSH/ClientProtheus	Nullable

Retornos

HTTP 200 - Ok

[
{
"aplicacao":"WSH/PDVSync",
"retaguarda":"Winthor/Protheus",
"servico":"PDVSync.Client.Down",
"idLojaRetaguarda":"07",
"dispositivo":"",
"idDevice":"",
"status":"Ativo",
"dataServidor":"2024-02-29T13:24:14.971127+00:00",
"idInquilino":"6a34W3REZqSCHVGpAk0L",
"dataAtualizacao":"2024-02-29T13:24:15.538758+00:00",
"dataCadastro":"2024-02-29T13:17:28.509172+00:00",
"id":"6",
"_expandables":[]
}
]

OBS: As datas retornadas na api estão em UTC+0 e deve ser convertida para o horário local no momento da visualização

...

icon	false

O método ConsultarStatusTicketLC_Integracao retorna o status atual do ticket de entrada solicitado.

...

Ambiente OnPremise

...

icon	false
title	Exemplo de Utilização:

Exemplo de consumo Via Postman:

Image Removed

...

title	Parâmetros de Entrada

...

Parar Processamento de mensagens com Erro.

Obs: Disponível a partir da versão 6.5.51

...

title	Parâmetros de Retorno

...

Tipos de status dos tickets de entrada:

Aguardando Processamento
Processado
Com Erro
Aguardando Confirmação

...

title	Exemplo de Chamada do Método

Bloco de código

theme	Confluence
title	Chamada método ConsultarStatusTicketLC_Integracao:
linenumbers	true

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:liv="http://LiveConnector/" xmlns:ren="http://schemas.datacontract.org/2004/07/Rentech.Framework.Data" xmlns:ren1="http://schemas.datacontract.org/2004/07/Rentech.PracticoLive.Connector.Objects">
   <soapenv:Header/>
   <soapenv:Body>
      <liv:ConsultarStatusTicketLC_Integracao>
         <liv:parametro>
            <ren1:Chave>xxxxxxxx-xxxe-xxxx-xxxx-xxxxxxxxxxx</ren1:Chave>
            <ren1:CodigoSistemaSatelite>xxxxxxx</ren1:CodigoSistemaSatelite>
            <ren1:NumeroTicket>0201211340546960</ren1:NumeroTicket>
         </liv:parametro>
      </liv:ConsultarStatusTicketLC_Integracao>
   </soapenv:Body>
</soapenv:Envelope>

...

theme	Confluence
title	Exemplo do retorno:
linenumbers	true

...

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 16

Nova versão 17

Chave

Descrição

Exemplo de funcionamento

Definição dos endpoints

POST

Exemplo de body da requisição

Definição dos campos de requisição

Retornos

GET

Definição dos campos de requisição

Retornos