Histórico da Página

Objetivo

Realizar a solicitação ao à API do parceiro (fiscal de caixa remoto), informando qual a rotina e demais dados para a liberação ou não da rotina do PDV.

...

PARÂMETRO	TIPO	OBRIGATÓRIO	DESCRIÇÃO
Authenticator	Object Json	Sim	Grupo com os dados para autenticação
Authenticator.Header	Object Json	Sim	Grupo com os dados do cabeçalho
Authenticator.Header.Description	String	Sim	Descrição da rotina a ser liberada
Authenticator.Header.IdStore	Integer	Sim	Código da loja
Authenticator.Header.IdTerminal	Integer	Sim	Código do PDV
Authenticator.Header.IdUser	Integer	Sim	Código do usuário (operador de caixa)
Authenticator.Header.Method	String	Sim	Rotina a ser liberada
Authenticator.Header.MethodStatus	String	Sim	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.Header.MethodTitle	String	Sim	Título da rotina a ser liberada
Authenticator.Sale	Object Json	Sim	Grupo com os dados da venda
Authenticator.Sale.AccountingDate	Date	Sim	Data do documento ou, quando não existir, da transação
Authenticator.Sale.DateTimeIssue	Date	Sim	Data e hora da requisição
Authenticator.Sale.IdDocument	Integer	Sim	Código do documento
Authenticator.Sale.Items	Array object Json	Não	Lista de produto(s) da venda
Authenticator.Sale.Items[0].Description	String	Sim	Descrição do produto
Authenticator.Sale.Items[0].InternalCode	Integer	Sim	Código interno do produto
Authenticator.Sale.Items[0].ItemNumber	Integer	Sim	Código de sequência do produto
Event	String	Sim	Tipo de evento da API
Execution	String	Sim	Status da execução
ID	String	Sim	ID da transação
Operation	String	Sim	Operação que está sendo enviada ("cotAuthenticador" para o evento POST)
Version	Integer	Sim	Número da versão

...

PARÂMETRO	TIPO	OBRIGATÓRIO	DESCRIÇÃO
Authenticator	Object Json	Sim	Grupo com os dados para autenticação
Authenticator.Id	String	Sim	ID da transação
Authenticator.Status	String	Sim	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.ReturnMessage	String	Sim	Mensagem para quando ocorrer erro ou a liberação da rotina for negada
Authenticator.IdUser	Integer	Sim	Código do usuário fiscal de caixa no PDV
Execution	String	Sim	Status da execução da resposta

Formatos de Resposta (Response Formats)

application/json

Exemplo(Sample)

Bloco de código

language	actionscript3

{
  "Authenticator": {
    "ID": "00130120231123080341",
    "Status": "arNone",
    "ReturnMessage": "",
    "IdUser": 0
  },
  "Execution": "cetCompleted"
}

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão 6

Chave

Objetivo

Formatos de Resposta (Response Formats)

application/json