| Informações |
|---|
|
| Expandir |
|---|
|
A api de StatusServicos foi criada com o intuito de que os serviços que utilizam o PDVSync possam sinalizar que estão funcionando. |
| Expandir |
|---|
| title | 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
|
| Informações |
|---|
| title | Definição dos enpoints |
|---|
|
| Expandir |
|---|
|
| title | POST /api/pdvsyncclient/v2/statusservico |
|---|
|
| Expandir |
|---|
| title | 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"
} |
| Expandir |
|---|
| title | 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 |
| Expandir |
|---|
|
| Expandir |
|---|
| {
"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": []
}
} |
| Expandir |
|---|
| title | HTTP 400 - Bad Request |
|---|
| Retorno ocorre quando uma 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"
}
]
} |
|
| Expandir |
|---|
| title | GET /api/pdvsyncclient/v2/statusservico |
|---|
|
| Expandir |
|---|
| title | 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 |
| Expandir |
|---|
|
| Expandir |
|---|
|
[
{
"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
