API Consulta Saldo

Documentação da API Consulta Saldo

Recuperar o saldo do seu plano

Método utilizado para saber a quantidade de créditos disponível.

GET

URL para requisição 

https://www.sintegraws.com.br/api/v1/consulta-saldo.php?token={token}

Parâmetros de requisição da API do Consulta Saldo

token
string

obrigatório
O seu token é gerado após o cadastro no portal.
Ver meu token

Exemplo de resposta da API Consulta Saldo
Uma resposta típica é composta por um JSON.

  • Status: 200 OK
  • Time: 200 ms
  • Size: 2021 bytes 
{"code":"0","status":"OK","message":"Pesquisa realizada com sucesso.","qtd_consultas_disponiveis":"1000"}

Campos de retorno da API Consulta Saldo

code string
Código de retorno utilizado para informar o status da requisição.
status string
Indica a situação da requisição.
Valores possíveis:
  • OK
  • ERROR
message string
Mensagem explicativa indicando o campo status.
qtd_consultas_disponiveis string
Quantidade de consultas disponíveis.
Retornos disponíveis
Status Request code status message
200 OK 0 OK Pesquisa realizada com sucesso.
401 Unauthorized 3 ERROR Token inválido.