Requisição de consulta de saldo e limite
A API abaixo disponibiliza informações para acompanhamento da quantidade de inserções que já foram realizadas, o saldo disponível para inserções de novos anúncios e as datas de renovação dos anúncios.
A URL usada para fazer a requisição do arquivo JSON é https://apps.eupreciso.com.br/v1.0/integradores/autoupload/balance, método POST. Essa requisição deve conter o access_token de cada anunciante no header como: Authorization: Bearer <access_token>.
Retorno de sucesso esperado
A consulta deve retornar um status code 200 e um JSON no corpo da resposta com a estrutura:
| Parâmetro | Valores | Obrigatório | Descrição |
|---|---|---|---|
reference | string | Sim | Data de referência (MM/AAAA) |
ads | object | Sim | Estrutura contendo quantidade de inserções e destaques do cliente, bem como respectivos gastos. |
balance | object | Sim | Estrutura contendo quantidade de créditos, balanço e saldo bloqueado do usuário. |
| Parâmetro | Valores | Obrigatório | Descrição |
|---|---|---|---|
performed | integer | Sim | Quantidade de anúncios publicados |
adsAmount | integer | Sim | Valor gasto com inserções |
bumpsPerfomed | integer | Sim | Quantidade de destaques contratados |
bumpsAmount | integer | Sim | Valor gasto com destaques |
| Parâmetro | Valores | Obrigatório | Descrição |
|---|---|---|---|
credits | integer | Sim | Saldo de créditos disponível para uso |
balance | integer | Sim | Saldo em reais disponível para saque ou uso no site |
blockedBalance | Integer | Sim | Saldo em reais bloqueado, referente a comissões pagas pelo site |
hasCreditCard | boolean | Sim | Se o anunciante tem cartão de crédito cadastrado |
limit | integer | Sim | Limite mensal de gastos para fins de alerta |
Retorno de erro esperado
Caso ocorra algum erro, a consulta retorna um status code > 200 e um JSON com o motivo e a mensagem do erro.
Códigos e motivos de erros da requisição retornados
| Status Code | Descrição | Motivo | Mensagem |
|---|---|---|---|
| 400 | Falta campo de authorization no header da requisição | BAD_REQUEST | Check the header field(s) |
| 401 | Token inválido | ACCESS_DENIED | Check the client authentication token |
| 429 | Rate Limit configurado quando o cliente fizer mais requisições por segundo do que deveria | RATE_LIMIT | You have exceeded the X requests in X seconds limit! |
| 500 | Erro interno inesperado | UNEXPECTED_INTERNAL_ERROR | Unexpected internal error. Try again later |
Exemplo de Retorno
Requisição: https://apps.eupreciso.com.br/v1.0/integradores/autoupload/balance
{
"reference": "12/2023",
"ads": {
"performed": 1,
"adsAmount": 0.95,
"bumpsPerformed": 1,
"bumpsAmount": 5
},
"balance": {
"credits": 985.81,
"balance": 294,
"blockedBalance": 0.25,
"hasCreditCard": false,
"limit": 50
}
}