• Home
  • APIs
  • Documentação Consulta Saldo

API: Documentação Consulta Saldo


O SintegraWS provê uma API para recuperação de dados de empresas brasileiras através de seu CNPJ. Existem quatro tipos de consulta:

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.



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
// 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 $('#qtd_disponivel').val(jsonSintegraWS.qtd_consultas_disponiveis); // Aqui exibimos uma mensagem caso tenha ocorrido algum erro } else { alert(jsonSintegraWS.message); } } });
<? // Seu token de acesso $token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"; //URL do serviço $service_url = 'https://www.sintegraws.com.br/api/v1/consulta-saldo.php?token=' . $token; //Faz a chamada do serviço utilizando o curl $curl = curl_init($service_url); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); $curl_response = curl_exec($curl); curl_close($curl); //Aqui fazemos o parse do json retornado $decoded = json_decode($curl_response); //Aqui exibimos uma mensagem caso tenha ocorrido algum erro if ($decoded->status == 'ERROR') { die("Erro: " . $decoded->message); } //Mostra o saldo na tela echo "Saldo disponível: " . $decoded->qtd_consultas_disponiveis; ?>
import requests token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" url = "https://www.sintegraws.com.br/api/v1/consulta-saldo.php?token="+token response = requests.request("GET", url) print(response.text)
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; } } }