Quick start

Padrões Técnicos#

A tabela a seguir resume os principais padrões de tecnologia utilizados:

CaracterísticaDescrição
Servidor de AplicaçãoJetty
Protocolo InternetTLS v1.1 ou TLS v1.
AutenticaçãoBasic Authentication
Padrão de troca de mensagensREST
Padrão da mensagemJSON
ProcessamentoSíncrono

Autenticação e Autorização no WebService#

Para se autenticar no WebService de Consulta, é necessário enviar em TODAS as requisições uma autenticação do tipo: Basic Authentication, onde o login e senha utilizados serão os mesmos utilizados no acesso ao SiTef- Conciliação.

O login enviado será usado como filtro para todas as requisições. Em outras palavras, caso o login enviado não possua permissão para resolução de pendência (níveis “Operador Relatórios” Loja ou Sede, por exemplo), não será retornada nenhuma pendência.

Além disso, apenas as transações das lojas associadas ao login enviado serão retornadas e suas respectivas pendências tratadas. Em outras palavras, caso o login enviado só tenha permissão de acesso a uma única loja, somente as transações desta loja serão retornadas e somente estas transações poderão ser tratadas.

E na utilização da consulta na plataforma SiTef GW/Express, a mesma regra das lojas será aplicada aos clientes. Somente as transações dos clientes relacionados ao login enviado serão retornadas, caso o parâmetro de clientes não tenha sido enviado.

Serviços#

O WebService de Consulta irá disponibilizar as seguintes funcionalidades:

  • Consulta por Transação
  • Consulta por Transações Pendentes
  • Cancelamento de Transação Pendente
  • Confirmação de Transação Pendente
  • Consulta de Transações Por Data
  • Consulta de Transações Por Data Exportação
  • Consulta de Transações Por BIN
  • Consulta Transações de Estorno
  • Consulta Transações de Estorno Por Data
  • Versão

O fluxo de comunicação é sempre iniciado pelo sistema do integrador/cliente através do envio de uma mensagem ao WSConsulta, requisitando a funcionalidade desejada.

A requisição será atendida na mesma conexão (todos os serviços serão síncronos). Em outras palavras, o processamento do pedido do serviço é concluído na mesma conexão, com a devolução de uma mensagem JSON contendo o retorno do processamento.

URL básica para acesso ao serviço:

https://identificador_do_serviço/