Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Aprenda como integrar perfeitamente nossas APIs em sua aplicação.
{
"statusCode": "[number]",
"message": "[string]",
"data": "[object]"
}
| Propriedade | Tipo | Descrição |
|---|---|---|
| statusCode | number | Este é o código de status da requisição que permite saber se sua requisição foi bem-sucedida ou não. Recomendamos que você use isso para determinar o resultado de uma chamada de API. |
| message | string | Este é um resumo da resposta e seu status. Por exemplo, ao tentar recuperar uma lista de clientes, a mensagem pode dizer “Transações obtidas com sucesso”. No caso de um erro, a chave message conterá uma descrição do erro, como na situação do cabeçalho de autorização acima. Esta é a única chave que é universal em todas as requisições. |
| data | object | Contém os resultados da sua requisição. Pode ser um objeto ou um array, dependendo da requisição feita. Por exemplo, uma requisição para recuperar uma única transação retornará um objeto de transação na chave data, enquanto a chave seria um array de transações se uma lista for solicitada. |
{
"meta": {
"totalItems": 704,
"itemCount": 100,
"itemsPerPage": 100,
"totalPages": 8,
"currentPage": 1
}
}
| Propriedade | Descrição |
|---|---|
| totalItems | O número total de itens disponíveis. Representa a contagem completa de itens em todas as páginas. |
| itemCount | O número de itens na página atual. Indica quantos itens estão sendo retornados na resposta atual. |
| itemsPerPage | O número máximo de itens por página. Define o limite de paginação definido para cada página. Padrão: 100 |
| totalPages | O número total de páginas disponíveis. É calculado com base no número total de itens e no número de itens por página. |
| currentPage | O número da página atual. Indica qual página da paginação está sendo retornada na resposta atual. Padrão: 1 |