Relatórios
API de relatórios é composta por quatro etapas:
Available - Etapa de requisição dos relatórios disponiveis.
Response - Nessa etapa podemos acompanhar o status de cada relatório solicitado
Donwload - Ultima etapa é a requisição do arquivo .csv
Available
| ENDPOINT |
/v1/report/available |
| METHOD |
GET |
| PARAMETERS |
TYPE |
DEMANDED |
NOTES |
|
|
|
A requisição será com base no usuario autenticado via [bearer token] |
| RETURN |
TYPE |
DEMANDED |
NOTES |
| id |
int |
|
Id do relatório, necessário para solicitar relatório na etapa de 2(request) |
| title |
string |
|
|
| description |
string |
|
|
RECEIVE EXAMPLE
[
{
"id": 1,
"title": "Mensagens",
"description": "Relatório de todas as mensagens"
},
{
"id": 2,
"title": "Atendimentos",
"description": "Relatório de todos os atendimentos"
}
]
Request
| ENDPOINT |
/v1/report/addnewreportrequest |
| METHOD |
POST |
| PARAMETERS |
TYPE |
DEMANDED |
NOTES |
| reportId |
int |
obrigatório |
Id do relatorio a ser requisitado. Obtido na etapa 1(available) |
| walletId |
int |
obrigatório |
Id da carteira. O resultado será filtrado para essa carteira. |
| startDate |
date |
obrigatório |
Data de inicio no formato yyyy-dd-MM |
| endDate |
date |
obrigatório |
Data de fim no formato yyyy-dd-MM |
| RETURN |
TYPE |
DEMANDED |
NOTES |
| token |
guid |
|
Guid de identificação do relatorio requisitado. Será usado na etapa 4(download) |
| status |
string |
|
Status do processamento: processando , erro , finalizado |
| trace |
string |
|
Caso ocorra algum erro, poderá ser resgatado nessa propriedade o motivo. |
SEND - EXAMPLE
{
"reportId": 1,
"walletId": 000,
"startDate":"2022-12-30",
"endDate":"2022-01-30"
}
RECEIVE EXAMPLE
{
"token": "27dcd558-01e2-4033-898c-fbbb765375b9",
"status": "processando",
"trace": null,
"reportId": 1,
"walletId": 000,
"startDate":"2022-12-30",
"endDate":"2022-01-30"
}
Response
| ENDPOINT |
/v1/report/getreportresponse |
| METHOD |
GET |
| PARAMETERS |
TYPE |
DEMANDED |
NOTES |
|
|
|
A requisição será com base no usuario autenticado via [bearer token] |
| RETURN |
TYPE |
DEMANDED |
NOTES |
| title |
string |
|
|
| token |
guid |
|
Guid de identificação do relatorio requisitado. Será usado na etapa 4(download) |
| insertDate |
date |
|
Data da requisição |
| status |
string |
|
processando , erro , finalizado |
| trace |
string |
|
Caso ocorra algum erro, poderá ser resgatado nessa propriedade o motivo. |
RECEIVE EXAMPLE
[
{
"title": "Mensagens",
"token": "11dcd558-01e2-4033-898c-fbbb765375b9",
"insertDate": "2023-01-05T09:35:31.633",
"startDate": "2022-12-30T00:00:00",
"endDate": "2023-01-01T00:00:00",
"status": "processando",
"trace": null
},
{
"title": "Mensagens",
"token": "00dcd558-01e2-4033-898c-fbbb765375b9",
"insertDate": "2023-01-05T09:35:31.633",
"startDate": "2022-12-30T00:00:00",
"endDate": "2023-01-01T00:00:00",
"status": "finalizado",
"trace": null
}
]
Download
| ENDPOINT |
/v1/report/download |
| METHOD |
POST |
| PARAMETERS |
TYPE |
DEMANDED |
NOTES |
| token |
string |
obrigatório |
Token do relatório. Obtido na etapa 2(request) |
| RETURN |
TYPE |
DEMANDED |
NOTES |
| url |
string |
|
|
| status |
string |
|
processando, erro, finalizado |
| trace |
string |
|
log de erros |
SEND - EXAMPLE
{
"token": "00dcd558-01e2-4033-898c-fbbb765375b9"
}
RECEIVE EXAMPLE
{
"token": "00dcd558-01e2-4033-898c-fbbb765375b9",
"url": "https://file.com",
"status": "finalizado"
}
RECEIVE EXAMPLE
{
"token": "00dcd558-01e2-4033-898c-fbbb765375b9",
"status": "processando",
"trace": "Arquivo não disponivel"
}
Consulte a página com exemplos: ACESSE AQUI
Está com algum problema?