Inclusão de reports

Inclusão de reportes de dados abertos na plataforma. Ao enviar um lote de reportes, a plataforma vai fazer o processo de validação sintática de cada reporte de maneira síncrona e devolver o resultado dessa validação na resposta. O status HTTP de retorno será 200 caso todos dos reportes enviados forem aceitos. Caso pelo menos 1 reporte esteja inconsistente, o status de retorno será 207 - veja documentação de cada status de retorno para mais informações.

Os dados inseridos na API de Reporte são sempre processados de maneira assíncrona, e sua persistência se utiliza de consistência posterior (eventual consistency), portanto, um registro tem um tempo de processamento em que ele não estará disponível para consulta até que ele seja persistido.

O limite de registros de cada lote é de 5.000 registros.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200Correto

application/json

O status 200 representa a situação onde todos os registros enviados no lote foram validados e serão direcionados para processamento. Se pelo menos 1 registro contiver problemas de validação, o retorno será 207 (veja descrição do status).

A operação vai devolver um array com todos os resultados, e garante que ele esteja na mesma ordem do array da requisição.

Body

🟢207Multiestado

🟠400Solicitação incorreta

🟠401Não autenticado

🟠403Permissão insuficiente

🟠406Não aceitável

🟠413O corpo da solicitação é muito grande

🟠415Tipo de mídia não suportado

🟠429Solicitações demais

🔴500Erro interno do servidor

curl --location --request POST '/report-api/v1/opendata/report' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '[ { "endpoint": "/open-banking/channels/v1/electronic-channels", "statusCode": 200, "httpMethod": "GET", "timestamp": "2021-11-11T18:08:08.421Z", "processTimespan": 120, "additionalInfo": { "clientIp": "192.168.10.11" } }, { "endpoint": "/open-banking/channels/v1/electronic-channels", "statusCode": 200, "httpMethod": "GET", "timestamp": "2021-11-11T18:08:08.421Z", "processTimespan": 120, "additionalInfo": { "clientIp": "192.168.10.11" } } ]'

Request

Responses