API: Simples Nacional




Documentação da API Simples Nacional


Recuperar dados de uma empresa no Simples Nacional

Método para recuperar as informações de uma empresa brasileira através do seu CNPJ. As informações são exatamente as mesmas retornadas pelo site do Simples Nacional.

    URL para requisição

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

Parâmetros passados na API do Simples Nacional


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 Simples nacional.


plugin

string

OBRIGATÓRIO

Site no qual deseja as informações, no caso do Simples Nacional informar "SN".

Exemplo de resposta da API Simples Nacional


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 Simples Nacional
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.
cnpj_matriz string CNPJ no formato 00.000.000/0000-00.
nome_empresarial string Razão social.
situacao_simples_nacional string Situação no Simples Nacional
situacao_simei string Situação no SIMEI
situacao_simples_nacional_anterior string Opções pelo Simples Nacional em Períodos Anteriores
situacao_simei_anterior string Opções pelo SIMEI em Períodos Anteriores
agendamentos string Agendamentos no Simples Nacional
eventos_futuros_simples_nacional string Eventos Futuros no Simples Nacional
eventos_futuros_simples_simei string Eventos Futuros no SIMEI
Retornos disponíveis
code status message
0 OK Pesquisa realizada com sucesso.
1 OK CNPJ não tem cadastro no site do simples nacional.
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 simples nacional esta com instabilidade.
8 ERROR Ocorreu um erro interno, por favor contatar o nosso suporte.
Exemplos
var token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"; var cnpj = "06990590000123"; var plugin = "SN"; $.ajax({ 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); } } });
<? // Informações para a chamada da API $token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"; $cnpj = "06990590000123"; $plugin = "SN"; //URL do serviço $service_url = "https://sintegraws.com.br/api/v1/execute-api.php?token=" . $token . "&cnpj=" . $cnpj . "&plugin=" . $plugin; //Faz a chamada da API $response = file_get_contents($service_url); //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 informações do simples nacional echo "Nome empresarial: " . $json->nome_empresarial; //preencher os outros campos // ... ?>
import requests token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" cnpj = "06990590000123"; plugin = "SN"; 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.Collections.Generic; 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", "SN"); } public static void consultaCNPJSintegraWS(String token, String cnpj, String plugin) { SimplesNacional simples_nacional = new SimplesNacional(); 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(); string jsonRetorno = jsonRetorno = result.Result; simples_nacional = Newtonsoft.Json.JsonConvert.DeserializeObject(jsonRetorno); if (simples_nacional.code.Equals("0")) { Console.WriteLine("Situação simples nacional: " + simples_nacional.situacao_simples_nacional); } else { Console.WriteLine("Erro: " + simples_nacional.message); } } } } } public class SimplesNacional { public String code { get; set; } public String status { get; set; } public String message { get; set; } public String cnpj { get; set; } public String cnpj_matriz { get; set; } public String nome_empresarial { get; set; } public String situacao_simples_nacional { get; set; } public String situacao_simei { get; set; } public String situacao_simples_nacional_anterior { get; set; } public String situacao_simei_anterior { get; set; } public String agendamentos { get; set; } public String eventos_futuros_simples_nacional { get; set; } public String eventos_futuros_simples_simei { 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: