API Reference

Alterando o formato da resposta

Alterando o formato da resposta para JSON ou XML

Nossa API oferece suporte a dois formatos de resposta: JSON e XML.

Essa flexibilidade permite que o seu software ou sistema possa se integrar escolhendo o formato que melhor atenda às suas necessidades.

Para solicitar um formato específico, você pode enviar um parâmetro no cabeçalho da solicitação com o nome Accept. Os valores possíveis para esse parâmetro são:

  • Accept: application/json - Para respostas em JSON (padrão)
  • Accept: text/xml - Para respostas no formato XML
{
  "cnpj": "98743958000177",
  "razaoSocial": "MIGUEL CAETANO DE OLIVEIRA",
  "nomeFantasia": "*****",
  "tipo": "Matriz",
  "dataAbertura": "1966-08-10",
  "situacaoCadastral": "Baixada",
  "dataSituacaoCadastral": "1987-04-30",
  "motivoSituacaoCadastral": "01 - EXTINCAO POR ENCERRAMENTO LIQUIDACAO VOLUNTARIA",
  "porte": "Demais",
  "capitalSocial": 0,
  "naturezaJuridica": "2135 - Empresário (Individual)",
  "logradouro": "ESTRADA PASSO DA BATALHA",
  "numero": "S N",
  "complemento": "TERREO",
  "cep": "94480755",
  "bairro": "ZONA RURAL",
  "municipio": "VIAMAO",
  "uf": "RS",
  "email": null,
  "telefone": " ",
  "situacaoEspecial": null,
  "dataSituacaoEspecial": null,
  "atividadePrincipal": {
    "codigo": "88.88-8.88",
    "descricao": "Atividade Econônica não informada"
  },
  "atividadeSecundaria": null,
  "quadroDeSocios": [],
  "dataAtualizacao": "2023-12-09"
}

<?xml version="1.0" encoding="UTF-8"?>
<GetCNPJResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <Cnpj>98743958000177</Cnpj>
   <RazaoSocial>MIGUEL CAETANO DE OLIVEIRA</RazaoSocial>
   <NomeFantasia>*****</NomeFantasia>
   <Tipo>Matriz</Tipo>
   <DataAbertura>1966-08-10</DataAbertura>
   <SituacaoCadastral>Baixada</SituacaoCadastral>
   <DataSituacaoCadastral>1987-04-30</DataSituacaoCadastral>
   <MotivoSituacaoCadastral>01 - EXTINCAO POR ENCERRAMENTO LIQUIDACAO VOLUNTARIA</MotivoSituacaoCadastral>
   <Porte>Demais</Porte>
   <CapitalSocial>0.00</CapitalSocial>
   <NaturezaJuridica>2135 - Empresário (Individual)</NaturezaJuridica>
   <Logradouro>ESTRADA PASSO DA BATALHA</Logradouro>
   <Numero>S N</Numero>
   <Complemento>TERREO</Complemento>
   <Cep>94480755</Cep>
   <Bairro>ZONA RURAL</Bairro>
   <Municipio>VIAMAO</Municipio>
   <Uf>RS</Uf>
   <Telefone />
   <AtividadePrincipal>
      <Codigo>88.88-8.88</Codigo>
      <Descricao>Atividade Econônica não informada</Descricao>
   </AtividadePrincipal>
   <QuadroDeSocios />
   <DataAtualizacao>2023-12-09</DataAtualizacao>
</GetCNPJResponse>

Aqui estão algumas vantagens de cada formato:

JSON: é um formato de dados leve e fácil de ler. Ele é amplamente utilizado em aplicativos da web e móveis. O JSON é uma boa escolha se você deseja uma resposta rápida e compacta.

XML: é um formato de dados mais antigo e mais complexo. Ele é amplamente utilizado em aplicativos corporativos e em sistemas legados. O XML é uma boa escolha se você deseja uma resposta mais estruturada e detalhada.

Lembre-se de que o formato padrão é JSON. Se você não especificar um formato, a API retornará uma resposta JSON. Certifique-se de escolher o formato correto para sua aplicação.

Restaram dúvidas, entre em contato com a nossa equipe através do e-mail [email protected]