• Home
  • APIs
  • Documentação API Sintegra

API: SINTEGRA


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 SINTEGRA


Recuperar dados de uma empresa no SINTEGRA

Método para recuperar as informações, incluindo a inscrição estadual de uma empresa brasileira através do seu CNPJ.
As informações são exatamente as mesmas retornadas pelo site do SINTEGRA.

    URL para requisição

https://www.sintegraws.com.br/api/v1/execute-api.php?token=TOKEN_DE_ACESSO&cnpj=CNPJ_DESEJADO&plugin=ST

Parâmetros passados na API do SINTEGRA


token

string

OBRIGATÓRIO

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


cnpj

string

OBRIGATÓRIO

CNPJ que deseja obter as informações do SINTEGRA.


plugin

string

OBRIGATÓRIO

Site no qual deseja as informações, no caso do SINTEGRA informar "ST".

Exemplo de resposta da API SINTEGRA


Uma resposta típica é composta por um JSON.

Atenção: utilize o CNPJ 06990590000123 como modo SandBox (teste) para que não seja efetuada cobrança nos créditos contratados.





Campos de retorno da API SINTEGRA
Campo Tipo Descrição
status string Indica a situação da requisição. Valores possíveis: OK, ERROR.
code string Código de retorno utilizado para informar o status da requisição.
message string Mensagem explicativa indicando o campo status.
cnpj string CNPJ no formato 00000000000000.
nome_empresarial string Razão social.
nome_fantasia string Nome fantasia.
inscricao_estadual string Inscrição Estadual.
tipo_inscricao string Tipo de Inscrição Estadual.
data_situacao_cadastral string Data da situação cadastral no formato dd-MM-yyyy.
situacao_cnpj string Situação cadastral do CNPJ.
situacao_ie string Situação Cadastral da Inscrição Estadual (IE).
data_inicio_atividade string Data do início da atividade no formato dd-MM-yyyy.
regime_tributacao string Regime de tributação.
informacao_ie_como_destinatario string Informação da Inscrição Estadual como destinatário.
porte_empresa string Porte da empresa.
cnae_principal objeto Atividade econômica principal.
cnae_principal.code string Código do CNAE principal
cnae_principal.text string Descrição da atividade econômica principal
data_fim_atividade string Data na qual a empresa foi cancelada no formato dd-MM-yyyy. Apenas para empresas com o status diferente de Ativo.
uf string Sigla da Unidade da Federação.
cep string CEP no formato 00000000.
municipio string Município.
bairro string Bairro.
logradouro string Logradouro.
complemento string Complemento.
numero string Número.
Retornos disponíveis
code status message
0 OK Pesquisa realizada com sucesso.
1 OK Nenhum estabelecimento encontrado no SINTEGRA. (significa que o CNPJ não tem cadastro no site oficial do Sintegra)
2 ERROR CNPJ inválido.
3 ERROR Token inválido.
4 ERROR Usuário não contratou nenhum pacote de créditos.
5 ERROR Os créditos contratados acabaram.
6 ERROR Plugin não existe.
7 ERROR Site do Sintegra esta com instabilidade.
8 ERROR Ocorreu um erro interno, por favor contatar o nosso suporte.
Exemplos
$.ajax({ var token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"; var cnpj = "06990590000123"; var plugin = "ST"; url: "https://sintegraws.com.br/api/v1/execute-api.php?token="+token+"&cnpj="+cnpj+"&plugin="+ plugin, method:'GET', complete: function(xhr){ // Aqui recuperamos o JSON retornado response = xhr.responseJSON; if(response.status == 'OK') { // Agora preenchemos os campos com os valores retornados $('#nome_empresarial').val(response.nome_empresarial); //preencher os outros campos // ... // Aqui exibimos uma mensagem caso tenha ocorrido algum erro } else { alert(response.message); } } });
<? // Seu token de acesso $token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"; $cnpj = "06990590000123"; $plugin = "ST"; //URL do serviço $service_url = "https://sintegraws.com.br/api/v1/execute-api.php?token=" . $token . "&cnpj=" . $cnpj . "&plugin=" . $plugin; //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 informações do simples nacional echo "Nome empresarial: " . $decoded->nome_empresarial; //preencher os outros campos // ... ?>
import requests token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" cnpj = "06990590000123"; plugin = "ST"; url = "https://sintegraws.com.br/api/v1/execute-api.php?token=" + token + "&cnpj=" + cnpj + "&plugin=" + plugin; 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) { consultaCNPJSintegraWS("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "06990590000123", "ST"); } private static void consultaCNPJSintegraWS(String token, String cnpj, String plugin) { Sintegra st = new Sintegra(); string jsonRetorno = ""; using (HttpClient client = new HttpClient()) { String url = "https://www.sintegraws.com.br/api/v1/execute-api.php?token=" + token + "&cnpj=" + cnpj + "&plugin=" + plugin; var response = client.GetAsync(url).Result; using (HttpContent content = response.Content) { Task result = content.ReadAsStringAsync(); jsonRetorno = result.Result; st = Newtonsoft.Json.JsonConvert.DeserializeObject(jsonRetorno); if (st.status.Equals("OK")) { Console.WriteLine("Situação Sintegra: " + st.situacao_ie); } else { Console.WriteLine("Erro: " + st.message); } } } } } public class Sintegra { public String code { get; set; } public String status { get; set; } public String message { get; set; } public String nome_empresarial { get; set; } public String cnpj { get; set; } public String inscricao_estadual { get; set; } public String tipo_inscricao { get; set; } public String data_situacao_cadastral { get; set; } public String situacao_cnpj { get; set; } public String situacao_ie { get; set; } public String nome_fantasia { get; set; } public String data_inicio_atividade { get; set; } public String regime_tributacao { get; set; } public String informacao_ie_como_destinatario { get; set; } public String porte_empresa { get; set; } public cnae_principal cnae_principal { get; set; } public String data_fim_atividade { get; set; } public String uf { get; set; } public String municipio { get; set; } public String logradouro { get; set; } public String complemento { get; set; } public String cep { get; set; } public String numero { get; set; } public String bairro { get; set; } } public class cnae_principal { public string code { get; set; } public string text { get; set; } } }