Visão Geral

Introdução

Bem vindo a documentação referente a API de transações do SiTef, onde os clientes poderão consultar suas transações, pendências e estornos, bem como resolver transações pendentes.

Esse projeto é uma reescrita da solução WS-Consulta, e tem como objetivo trazer uma alternativa mais performática, resiliente e com maior confiabilidade para os clientes.

As formas habituais para Consulta de estado de transações e tratamento de transações pendentes requerem o uso dos relatórios do SiTef®, SiTef Express ou outros.

Essas opções não permitem a automatização das operações.

Para contornar este problema foi criado um serviço de Consulta e resolução de pendências on-line que será acessado por um “App Server” (desenvolvido pelo integrador/Cliente) permitindo a listagem, validação do status e resolução de pendência das transações do SiTef-Express.

A API utiliza Springboot web para atender as requisições HTTPS. Dentre os endpoints estão disponibilizados os serviços de tratamento de pendências e verificação de status de transação via protocolo REST. Para a autenticação e autorização, é utilizado o protocolo OAuth 2.0 Client Credentials que é gerenciado por um servidor de autenticação baseado no Keycloak

Objetivo

Esta documentação tem como objetivo apresentar a definição das interfaces e critérios técnicos necessários para utilização das funcionalidades da API.

Público-Alvo

Esta documentação é direcionada à equipe de desenvolvimento de integradores/clientes, ou qualquer interessado em usar o serviço de consulta e resolução de pendências das transações.