Reporting API

O datahub disponibiliza a reporting API, com tecnologia graphql, que permite a consulta e a extração de dados brutos. Esses dados podem ser trabalhados pelo emissor na construção de queries e relatórios, utilizando os filtros desejados.

A reporting API oferece flexibilidade permitindo a criação de critérios de filtro, seleção de colunas e limitação da quantidade de dados para aumentar a granularidade dos dados extraídos.


Vantagens da reporting API

A maior vantagem da reporting API é a democratização do acesso aos dados ao disponibilizar a informação que a Dock possui, empoderando os emissores com dados brutos para serem enriquecidos. A informação disponibilizada é equilibrada para cada cenário de negócio, portanto a reporting API se encaixa nas necessidades de qualquer emissor.

O tempo de transmissão da informação pode ser próximo ao tempo real, a depender da modalidade de Fluxo utilizada. Outros diferenciais são a disponibilidade de arquivos em diversos formatos - JSON para consultas, CSV, JSON e txt para extração dos dados brutos, ambos comprimidos (zip) - e uma variedade de tipos de filtragem disponíveis em qualquer coluna e tabela.


Aplicabilidade da reporting API

Alguns exemplos de utilidade para a reporting API são:

  • Conciliação de dados como saldos, compras e eventos do Webhook, para quando o emissor quer confrontar, validar e enriquecer os dados.
  • Geração de arquivos para integrações, para o emissor já habituado a fazer a integração através de arquivos.
  • Ingestão para um data lake, função que tem sido tendência, principalmente para emissores digitais e fintechs, já que possibilita a construção de um repositório e banco de dados descentralizado que pode receber qualquer informação por parte de qualquer fonte.
  • Contribuir para times de business intelligence e ciência de dados com informações que embasam a análise e compreensão de comportamentos para a tomada de decisões.

Fluxos da reporting API

Setup da reporting API

Homologação

A base de homologação é uma base estática, ou seja, ela restaura um backup de um determinado dia da base de dados, não recebendo novas informações. Além disso, ela é mascarada. A nível autenticação, os certificados para homologação são gerados pela Dock e disponibilizados no chamado de solicitação do ambiente.

Produção

O certificado aberto para solicitação do setup em produção do reporting API deve vir acompanhado de um certificado CSR gerado pelo emissor e com as informações de tabelas que eles desejam consumir. Após isso será feita a construção do ambiente e assinatura do certificado, e este certificado deve estar assinado preferencialmente pela Dock, para devolução ao emissor via chamado. Para mais detalhes sobre como obter o certificado, é só utilizar o link: Autenticação.

👍

Dica

O emissor pode ter mais de um certificado para disponibilizar a API para outros times internos e, assim, restringir o acesso de acordo com as entidades disponíveis.

Requisição de dados

A aplicação tem dois fluxos de requisição de dados, conforme detalhado abaixo:

  • Síncrono: possibilita a consulta imediata.
FIG: Fluxo síncrono de requisição de dadosFIG: Fluxo síncrono de requisição de dados

FIG: Fluxo síncrono de requisição de dados

1 - Consulta e retorna os dados consolidados direto na API para o emissor receber a informação imediatamente.

🚧

Atenção

Todas as informações disponíveis na API possuem um sincronismo próximo ao tempo real entre as bases de origem (base produtiva) e a base consolidada (data lake).

  • Assíncrono: possibilita a exportação dos dados em arquivos e disponibiliza um link para fazer download. A informação fica armazenada em uma nuvem da Dock.
FIG: Fluxo assíncrono de requisição de dados.FIG: Fluxo assíncrono de requisição de dados.

FIG: Fluxo assíncrono de requisição de dados.

1 - Extração de dados consolidados por arquivo: o emissor recebe o token;
2 - Status do token: é enviado quando a exportação termina, o token é necessário para verificar a conclusão do download;
3 - Pedido de exportação de dados consolidados: retorna um link (URL) para baixar o arquivo solicitado.

Para entender todas as regras da consulta, os parâmetros de diferenciação da requisição e como solicitar o download do arquivo, é só utilizar o link: Como funciona a reporting API.

Status da geração do arquivo da reporting API

Após solicitada a geração do arquivo, as informações para download e identificação são recebidas. Elas podem ser utilizadas para obter o status da geração do arquivo através do link: Verificar o Status do Arquivo.


Delimitações da reporting API

Existem as seguintes delimitações:

  • Consulta de dados síncronas de até 10 mil linhas por requisição;
  • Exportação de dados em arquivo com até 5 milhões de linhas;
  • Solicitação de até 5 arquivos simultâneos por emissor;
  • Execução de até 5 requisições no modelo síncrono de forma paralela por tabela;
  • Todas as requisições realizadas devem passar um filtro na coluna de UpdatedAt informando o período que se deseja os dados. Caso contrário, a reporting API aplicará um filtro padrão de um dia de intervalo (D-1).

Entidades contempladas na reporting API

O objetivo da reporting API é disponibilizar o máximo de dados relevantes aos emissores acerca de entidades, como autorização, conta, portador, cartão, fatura, contábil, estabelecimento, pagamento, produtos, ajuste e notificação. As entidades contempladas e suas respectivas funções estão apresentadas abaixo:

Bancos

• Bancos: reconhece e descreve bancos e instituições financeiras seguindo o Identificador do Sistema de Pagamento Brasileiro (ISPB). Para conhecer os detalhes e os campos da entidade, é só acessar o link: Bancos;

Produtos

• Produtos: contém informações sobre o registro do produto, como pré-pago ou cartão de crédito, Visa ou Mastercard. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Produtos.

Pessoa

As entidades disponíveis para pessoa são:

• Pessoas: contém informações de registro da pessoa. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Pessoas;

• Endereço: contém informações sobre endereço de pessoas ou empresas. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Endereço;

• Propostas: contém informações sobre as propostas que foram enviadas para revisão. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Propostas;

Conta

• Contas: contém informações sobre as vinculações de uma conta, como produtos, pessoas, origem comercial, além de algumas informações relacionadas a pagamentos e a faturas. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Contas;

• Limites Disponíveis: contém informações sobre os limites de crédito do titular do cartão. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Limites Disponíveis;

• Situações de Saldos: contém informações do saldo da conta do titular.
Para conhecer os detalhes e os campos da entidade, é só acessar o link: Situações de saldos.

Status de Contas

Status de Contas: contém informações de registro dos tipos de status que uma conta titular pode ter (ex.: status de conta que permite realizar compras e não permite saques). Para conhecer os detalhes e os campos da entidade, é só acessar o link: Status de Contas;

Cartão

• Cartões: contém informações sobre os dados do titular do cartão. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Cartões;

Autorização

As entidades disponíveis para autorização são:

• Mensagens de Autorização: contém informações detalhadas sobre transações de autorização, como compra, retirada e pagamento. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Mensagens de Autorização;

• Operações: contém informações sobre o registro dos tipos de operações existentes, como compras, saques, pagamentos e taxas. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Operações;

• Compras Não Processadas: contém informações sobre compras autorizadas, mas que ainda não foram processadas pela fatura. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Eventos de Compra não Processados;

• Compras Processadas: contém informações sobre aquelas compras que foram autorizadas e processadas para atualizações de saldos e contabilização em faturas. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Eventos de Compra Processados;

Ajuste

As entidades disponíveis para ajuste são:

• Tipos de Ajustes: contém informações de registro dos tipos de ajustes existentes e que são possíveis de serem lançados na conta do emissor. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Tipos de Ajustes;

• Ajuste Lançado: contém informações sobre a postagem de ajustes financeiros na conta do portador. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Ajuste Lançado.

Fatura

As entidades disponíveis para fatura são:

• Boleto Bancário: contém informações sobre todos os tipos de boletos gerados. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Boleto Bancário;

• Controle de Parcelamento: controle de informações das parcelas de qualquer operação de débito parcelado. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Controle de Parcelamento;

• Controlador de Data de Vencimento: contém informações de registro para o calendário de corte de faturas. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Controlador de Data de Vencimento;

• Acordos: contém informações sobre os acordos oferecidos aos titulares para negociação de dívidas. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Acordos;

Pagamento

• Pagamento Lançado: contém informações de fatura de cartão de crédito, recarga de cartão pré-pago e depósito na conta de portadores. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Eventos de Pagamentos;

Contábil

As entidades disponíveis para contábil são:

• Transações Contábeis de Portadores de Cartão: contém informações de transações publicadas nas faturas dos detentores, como compras aprovadas, pagamentos processados, retiradas aprovadas e cobranças. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Transações Contábeis de Portadores de Cartão;

• Status de Contas Contábeis: contém informações do saldo da conta do titular.
Para conhecer os detalhes e os campos da entidade, é só acessar o link: Situações de Contábeis;

• Lançamentos Contábeis: descrevem os lançamentos contábeis do titular do cartão para transações de crédito ou débito em uma conta específica.
Para conhecer os detalhes e os campos da entidade, é só acessar o link: Lançamentos Contábeis.

Estabelecimento

• Agenda lojista: contém informações de transação do lojista que foram processadas para o calendário dele. Para conhecer os detalhes e os campos da entidade, é só acessar o link: Horários do Comerciante.

Notificação

• SMS: contém informações sobre o SMS cadastrado para envio.
Para conhecer os detalhes e os campos da entidade, é só acessar o link SMS.

🚧

Atenção

As entidades "lançamentos contábeis" e "status de contas" só estarão disponíveis após o processamento noturno, em D-1 (um dia de atraso), pois é quando elas são geradas.


Did this page help you?