Créditos

Os recursos relacionados a créditos permitem a consulta e gestão das informações referentes aos créditos de consulta disponíveis e histórico de compras na plataforma.

Autorização

Todos os endpoints de créditos exigem autorização do usuário através de um access token. Esse token deve ser enviado no cabeçalho Authorization no formato Authorization: Bearer <access_token>.

Retorno

O retorno das requisições aos endpoits de créditos seguem um padrão unificado, onde:

• O campo status contém um código de resposta, mensagem descritiva e detalhes sobre o retorno (sempre que aplicável). Para mais informações sobre códigos e mensagens de retorno, visite a página códigos de retorno.
• O campo data contém o resultado da requisição, onde:
  • Em caso de sucesso, irá retornar as informações relacionadas à requisição.
  • Em caso de falha, irá retornar vazio.

Exemplos de retorno

Sucesso

{
  "status": {
    "code": 3000,
    "message": "Success",
    "details": ""
  },
  "data": {
    "balance": 1000
  }
}

Falha

{
  "status": {
    "code": 3001,
    "message": "Authorization error",
    "details": "Access token invalid, expired or revoked"
  },
  "data": { }
}