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.

Informações para Requisição (Request Information)

Parâmetros do Corpo (Body Parameters)

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 (que será consultando depois no evento GET)
Operation	String	Sim	Operação que está sendo enviada ("cotAuthenticador" para este evento POST)
Version	Integer	Sim	Número da versão

Formatos de Requisição (Request Formats)

application/json

Exemplo (Sample)

Bloco de código

language	actionscript3

{
    "Authenticator": {
        "Header": {
            "Description": "Cancelamento do documento",
            "IdStore": 1,
            "IdTerminal": 301,
            "IdUser": 2,
            "Method": "mtCancelarCupom",
            "MethodStatus": "arNone",
            "MethodTitle": "Autenticacao de usuario"
        },
        "Sale": {
            "AccountingDate": "2023-11-23T00:00:00",
            "DateTimeIssue": "2023-11-23T08:03:41",
            "IdDocument": 122552,
            "Items": [
                {
                    "Description": "AJINOMOTO REFIL 100G",
                    "InternalCode": "7274",
                    "ItemNumber": 1
                },
                {
                    "Description": "ACENDEDOR IMPERIAL TOCA FOGO C/6",
                    "InternalCode": "1825",
                    "ItemNumber": 2
                }
            ]
        }
    },
    "Event": "cetBefore",
    "Execution": "cetContinue",
    "ID": "00130120231123080341",
    "Operation": "cotAuthenticator",
    "Version": 1
}

Informações para Resposta (Response Information)

Parâmetros do

...

Header (

...

Header Parameters)

PARÂMETRO	TIPO

TAMANHOversionIntegerNúmero da versãopersonObject JsonObjeto json dos dados do clienteperson.documentsArray object JsonLista de documentosperson.documents[0].document
OBRIGATÓRIO DESCRIÇÃO
idstringIdentificado único da resposta
x-authtoken
String Sim
Documento
Token de autenticação do
clienteperson.documents[0].documentType
Tipo de documento do cliente
Tipo de documento de identificação
cdtCPF - CFP
cdtCNPJ - CNPJ
cdtIE - Inscrição estadual
cdtRG - RG
person.NameString50SimNomeperson.EmailString80NãoEmail do clienteperson.KindStringSim
Tipo de pessoa
cktPhysical - Física
cktLegal - Jurídica
person.TaxpayerStringNão
Contribuinte de ICMS
yntYes - Sim
yntNo - Não
person.PublicAgencyStringNão
Órgão público
yntYes - Sim
yntNo - Não
person.customerObject jsonObjeto json dos dados do clienteperson.customerGlobalLimitDouble9, 2NãoValor limite globalperson.customer.DeadlineInteger3NãoPrazo máximo em diasperson.customer.CreditStatusStringNão
Situação do crédito
ccsAlert - Alerta
ccsReleased - Liberado
ccsBlocked - Bloqueado
ccsSuspended - Suspenso
person.customer.NoteString250NãoObservaçãoperson.customer.CardNumberInteger15NãoNúmero do cartãoperson.customer.BusinessSituationStringNão
Situação comercial
bstReleased - Liberado
bstBlocked - Bloqueado
person.addressesObject jsonObjeto json com os dados de endereçoperson.addresses.KindAddressStringSim
Tipo do endereço
katMain - Principal
katCharge - Cobrança
katDelivery - Entrega
katCorrespondence - Correspondência
katPickUp - Retirada
person.addresses.PublicPlaceString60SimDescrição do logradouroperson.addresses.PublicPlaceNumberString10NãoNúmero do logradouroperson.addresses.NeighbourhoodString50SimDescrição do bairroperson.addresses.ComplementString60NãoComplemento de endereçoperson.addresses.CityString60SimNome da cidadeperson.addresses.FederativeUnitString2SimEstado da cidadeperson.addresses.ZipCodeInteger8SimCep sem formataçãoperson.addresses.IBGEInteger12NãoCódigo da cidade no IBGE
parceiro

Parâmetros do Corpo (Body Parameters)

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 (que será consultando depois no evento GET)
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

Exemplosimplificado(Sample)

Bloco de código

language	actionscript3

{
  "id": "527dd979-6f51-4046-a6a7-a8e20c4a6a54",
  "version": 1,
  "person": Authenticator": {
    "documentsID":[
      {
        "document":"91347879846"00130120231123080341",
        "documentTypeStatus":"cdtCPF"
      },
      {
        "document":"253716652"arNone",
        "documentType":"cdtRG"
      }
    ],
    "NameReturnMessage": "Edson Luan Bernardo Nogueira",
    "kind": "cktPhysical",
    "addresses": [
      {
        "kindAddress": "katMain",
        "publicPlace": "Rua Baiacu",
        "publicPlaceNumber": "482",
        "neighbourhood": "Eldorado",
        "complement": "",
        "city": "Diadema",
        "federativeUnit": "SP",
        "zipCode": "14065540",
        "iBGE": 1234
      }
    ]
  }
}

application/json

...

Bloco de código

language	actionscript3

{
  "id": "527dd979-6f51-4046-a6a7-a8e20c4a6a54",
  "version": 1,
  "person": {
    "documents":[
      {
        "document":"91347879846",
        "documentType":"cdtCPF"
      },
      {
        "document":"253716652",
        "documentType":"cdtRG"
      }
    ],
    "Name": "Antonio Arthur João da Mota",
    "email":"[email protected]",
    "kind":"cktPhysical",
    "taxpayer":"yntNo",
    "publicAgency":"yntNo",
    "customer":{
      "globalLimit":0,
      "deadline":0,
      "creditStatus":"ccsReleased",
      "note":"",
      "cardNumber":0,
      "businessSituation":"bstReleased"
    IdUser": 0
  },
    "addresses": [
      {
        "kindAddress": "katMain",
        "publicPlace": "Rua Nestor Ferreira da Rocha",
        "publicPlaceNumber": "368",
        "neighbourhood": "Vila Iolanda II",
        "complement": "",
        "city": "São Paulo",
        "federativeUnit": "SP",
        "zipCode": "08473400",
        "iBGE": 1234
      }
    ]
  }"Execution": "cetCompleted"
}

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Objetivo

Informações para Requisição (Request Information)

Parâmetros do Corpo (Body Parameters)

Formatos de Requisição (Request Formats)

application/json

Informações para Resposta (Response Information)

Parâmetros do

Header (

Header Parameters)

Parâmetros do Corpo (Body Parameters)

Formatos de Resposta (Response Formats)

application/json

application/json