Home TOTVS Varejo Supermercados

Árvore de páginas

  • Criado por Usuário desconhecido (rodolfo.barros), última alteração em 23 nov, 2023

Objetivo

Realizar a consulta na API do parceiro (fiscal de caixa remoto) para a liberação ou não da rotina do PDV.

Informações para Request (Request Information)

Parâmetros do Header (Header Parameters)

PARÂMETROTIPOOBRIGATÓRIODESCRIÇÃO
x-idStringSim

ID da transação que foi solicitada anteriormente no evento POST

Informações para Resposta (Response Information)

Parâmetros do Header (Header Parameters)

PARÂMETROTIPOOBRIGATÓRIODESCRIÇÃO
x-authtokenStringSim

Token de autenticação do parceiro

Parâmetros do Corpo (Body Parameters)

PARÂMETROTIPOOBRIGATÓRIODESCRIÇÃO
AuthenticatorObject JsonSim

Grupo com os dados para autenticação

Authenticator.IdStringSim

ID da transação que foi solicitada anteriormente no evento POST

Authenticator.StatusStringSim

Status da liberação da rotina solicitada. Legenda:

arNone: envio da requisição (inicialização);

arPending: requisição pendente;

arAuthorized: requisição autorizada pelo fiscal de caixa;

arNotAuthorized: requisição negada pelo fiscal de caixa;

arCanceled: requisição cancelada (API fora do ar, timeout, usuário cancelou a solicitação, tempo limite atingido, etc).

Authenticator.ReturnMessageStringSim

Mensagem para quando ocorrer erro ou a liberação da rotina for negada

Authenticator.IdUserIntegerSim

Código do usuário fiscal de caixa no PDV

ExecutionStringSim

Status da execução da resposta


Formatos de Resposta (Response Formats)

application/json

Exemplo (Sample)

{
  "Authenticator": {
    "ID": "00130120231123080341",
    "Status": "arNotAuthorized",
    "ReturnMessage": "Negado pelo motivo...",
    "IdUser": 17
  },
  "Execution": "cetCompleted"
}