API: Documentação 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.

    URL para requisição

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

Parâmetros


token

string

OBRIGATÓRIO

Após seu cadastro seu token está localizado em: Nossas APIs > Meu Token.


Exemplo de resposta


Uma resposta típica é composta por um JSON.



  •  200  OK
  • Time: 0
  • Size: 0
Campos de retorno da API Consulta Saldo
Campo Tipo Descrição
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
code status message
0 OK Pesquisa realizada com sucesso.
3 ERROR Token inválido.
Exemplos de códigos
var request = require("request"); var options = { method: 'GET', url: 'https://www.sintegraws.com.br/api/v1/consulta-saldo.php', qs: { token: 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' } }; request(options, function (error, response, body) { if (error) throw new Error(error); // Aqui recuperamos e realizamos o parse do JSON retornado var resposeSWS = JSON.parse(body); console.log(resposeSWS.status); });
var data = null; // Endpoint da API Consulta saldo const url = new URL('https://www.sintegraws.com.br/api/v1/consulta-saldo.php'); // Parâmetros utilizados na chamada da API const params = new URLSearchParams(); params.set('token', 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'); url.search = params.toString(); var xhr = new XMLHttpRequest(); xhr.addEventListener("readystatechange", function () { if (this.readyState === this.DONE) { // Aqui recuperamos e realizamos o parse do JSON retornado var resposeSWS = JSON.parse(this.responseText); if(resposeSWS.code == "0") { // Agora preenchemos os campos com os valores retornados document.getElementById("#saldo_disponivel").innerHTML = resposeSWS.qtd_consultas_disponiveis; //preencher os outros campos // ... } else { // Aqui exibimos uma mensagem caso tenha ocorrido algum erro alert(response.message); } } }); xhr.open("GET", url); xhr.send(data);
// Seu token de acesso var token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"; $.ajax( { url: "https://www.sintegraws.com.br/api/v1/consulta-saldo.php?token="+token, method:'GET', complete: function(xhr){ // Aqui recuperamos o JSON retornado jsonSintegraWS = xhr.responseJSON; if(jsonSintegraWS.status == 'OK') { // Agora preenchemos os campos com os valores retornados $('#saldo_disponivel').val(jsonSintegraWS.qtd_consultas_disponiveis); // Aqui exibimos uma mensagem caso tenha ocorrido algum erro } else { alert(jsonSintegraWS.message); } } });
<? // Endpoint da API Consulta saldo $service_url = 'https://www.sintegraws.com.br/api/v1/consulta-saldo.php'; // Parâmetros utilizados na chamada da API $params = array( 'token' => 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' ); $service_url = $service_url . '?' . http_build_query($params); $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => $service_url, CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 90, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", )); // Faz a chamada da API $response = curl_exec($curl); // Aqui fazemos o parse do JSON retornado $json = json_decode($response); // Aqui exibimos uma mensagem caso tenha ocorrido algum erro if ($json->code != '0') { die("Erro " . $json->code . ": " . $json->message); } // Mostra o Saldo disponível echo "Saldo disponível: " . $json->qtd_consultas_disponiveis; ?>
<? $request = new HttpRequest(); // Endpoint da API Consulta saldo $request->setUrl('https://www.sintegraws.com.br/api/v1/consulta-saldo.php'); $request->setMethod(HTTP_METH_GET); // Parâmetros utilizados na chamada da API $request->setQueryData(array( 'token' => 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', )); // Faz a chamada da API $response = $request->send(); // Aqui fazemos o parse do JSON retornado $json = json_decode($response->getBody()); // Aqui exibimos uma mensagem caso tenha ocorrido algum erro if ($json->code != '0') { die("Erro " . $json->code . ": " . $json->message); } // Mostra o Saldo disponível echo "Saldo disponível: " . $json->qtd_consultas_disponiveis; // preencher os outros campos // ... ?>
<? $client = new http\Client; $request = new http\Client\Request; // Endpoint da API Consulta saldo $request->setRequestUrl('https://www.sintegraws.com.br/api/v1/consulta-saldo.php'); $request->setRequestMethod('GET'); // Parâmetros utilizados na chamada da API $request->setQuery(new http\QueryString(array( 'token' => 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' ))); // Faz a chamada da API $client->enqueue($request)->send(); $response = $client->getResponse(); // Aqui fazemos o parse do JSON retornado $json = json_decode($response->getBody()); // Aqui exibimos uma mensagem caso tenha ocorrido algum erro if ($json->code != '0') { die("Erro " . $json->code . ": " . $json->message); } // Mostra o Saldo disponível echo "Saldo disponível: " . $json->qtd_consultas_disponiveis; // preencher os outros campos // ... ?>
import requests url = "https://www.sintegraws.com.br/api/v1/consulta-saldo.php" querystring = {"token":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"} response = requests.request("GET", url, params=querystring) print(response.text)
import http.client token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" url = "/api/v1/execute-api.php?token=" + token; conn = http.client.HTTPSConnection("www.sintegraws.com.br") conn.request("GET", url) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
HttpResponse response = Unirest.get("https://www.sintegraws.com.br/api/v1/consulta-saldo.php") .queryString("token", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX") .asString();
using System; using System.Net.Http; using System.Threading.Tasks; namespace Consumo_Sintegra_WS_Exemplo { public class Program { static void Main(string[] args) { GetSaldoSintegraWS("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"); } private static void GetSaldoSintegraWS(String token) { SaldoSintegraWS saldoSintegraWS = new SaldoSintegraWS(); string jsonRetorno = ""; using (HttpClient client = new HttpClient()) { String url = "http://sintegraws.com.br/api/v1/consulta-saldo.php?token=" + token; var response = client.GetAsync(url).Result; using (HttpContent content = response.Content) { Task result = content.ReadAsStringAsync(); jsonRetorno = result.Result; saldoSintegraWS = Newtonsoft.Json.JsonConvert.DeserializeObject(jsonRetorno); if (saldoSintegraWS.status.Equals("OK")) { Console.WriteLine("Saldo disponível: " + saldoSintegraWS.qtd_consultas_disponiveis); } else { Console.WriteLine("Erro: " + saldoSintegraWS.message); } } } } } public class SaldoSintegraWS { public String code { get; set; } public string status { get; set; } public string message { get; set; } public string qtd_consultas_disponiveis { get; set; } } }

O SintegraWS provê uma API para recuperação de dados de empresas brasileiras através de seu CNPJ. Existem quatro tipos de consulta, veja as documentações abaixo: