Ir para o conteúdo

Guias rápidos

Como autenticar na API Consulta CNPJ

As APIs disponibilizadas pela plataforma API SERPRO utilizam o protocolo OAuth2 para realizar a autenticação e autorização de acesso das APIs contratadas. Siga os passos abaixo para se autenticar e consumir a api CNPJ.

1. Primeiro passo - Obtenha Consumer Key e Consumer Secret

Para consumir as APIs, você deverá utilizar os dois códigos (Consumer Key e Consumer Secret) disponibilizados na Área do Cliente. Esses códigos servem para identificar o contrato. As credenciais de acesso devem ser obtidas a partir da área do cliente Serpro.

Exemplos de códigos: 

Consumer Key: djaR21PGoYp1iyK2n2ACOH9REdUb   
Consumer Secret: ObRsAJWOL4fv2Tp27D1vd8fB3Ote

Aviso importante

O Consumer Key e Consumer Secret identificam seu usuário e seu contrato com o SERPRO. Mantenha essas informações protegidas.

2. Segundo passo - Solicite o Bearer Token

Para consultar as APIs, é necessário obter um token de acesso temporário (Bearer). Esse token possui uma (1) hora de validade e, sempre que expirado, repita este passo de requisição de um novo token de acesso.

Como solicitar o Token de Acesso (Bearer)

Para solicitar o token temporário é necessário realizar uma requisição HTTP POST para o endpoint Token https://gateway.apiserpro.serpro.gov.br/token, informando as credenciais de acesso (consumerKey:consumerSecret) no HTTP Header Authorization, no formato base64, conforme exemplo abaixo. 

[HEAD] Authorization: Basic base64(Consumer Key:Consumer Secret) 
[HEAD] Content-Type: application/x-www-form-urlencoded 
[POST] grant_type=client_credentials

Para utilização no parâmetro Authorization, é necessário concatenar os códigos Consumer Key e Consumer Secret, separados pelo caracter ":", e converter o resultado em BASE64. No exemplo a seguir, é retornada a string ZGphUjIx[...]IzT3RlCg:

echo -n "djaR21PGoYp1iyK2n2ACOH9REdUb:ObRsAJWOL4fv2Tp27D1vd8fB3Ote" | base64

Resultado:

ZGphUjIxUEdvWXAxaXlLMm4yQUNPSDlSRWRVYjpPYlJzQUpXT0w0ZnYyVHAyN0QxdmQ4ZkIzT3RlCg

Abaixo segue um exemplo de chamada via cUrl:

curl -k -d "grant_type=client_credentials" \
-H "Authorization: Basic ZGphUjIxUEdvWXAxaXlLMm4yQUNPSDlSRWRVYjpPYlJzQUpXT0w0ZnYyVHAyN0QxdmQ4ZkIzT3RlCg" \
https://gateway.apiserpro.serpro.gov.br/token

Content-type

Caso experiencie erros de "415 Unsupported Media Type" na chamada de solicitação do Token, utilize o campo do Header "Content-Type" com o valor "application/x-www-form-urlencoded"

[HEAD] Content-type: "application/x-www-form-urlencoded"

3. Terceiro passo - Receba o Token

Como resultado do passo anterior, o endpoint informará o token de acesso a API, no campo access_token da mensagem json de retorno. Este token deve ser informado nos próximos passos. Fique atento ao tempo de renovação do Token de acesso.

Receba o Token

Como resultado, o endpoint informará o token de acesso a API, no campo access_token da mensagem json de retorno. Este token deve ser informado nos próximos passos.

{
    "scope": "am_application_scope default", 
    "token_type": "Bearer", 
    "expires_in": 3295, 
    "access_token": "c66a7def1c96f7008a0c397dc588b6d7"
}

Renovação do Token de Acesso

O token de acesso possui uma (1) hora de validade. Recomenda-se gerar um token de aceso por hora. Utilize o token de acesso até o momento que o gateway retorne um HTTP CODE 401 após realizar uma requisição para uma API. Para renovação do token, repita o Segundo Passo Como solicitar o Token de Acesso (Bearer) .

4. Quarto passo - Fazendo uma requisição

Realizando consulta às APIs

De posse do Token de Acesso, faça a requisição a API CNPJ Trial. 

curl -X GET "https://gateway.apiserpro.serpro.gov.br/consulta-cnpj-trial/v1/cnpj/34238864000168" \
-H "accept: application/json" \
-H "Authorization: Bearer 06aef429-a981-3ec5-a1f8-71d38d86481e" \

No exemplo acima foram utilizados os seguintes parâmetros:

  • [HEADER] Accept: application/json
    Informamos o tipo de dados que estamos requerendo, nesse caso JSON

  • [HEADER] Authorization: Bearer 06aef429-a981-3ec5-a1f8-71d38d86481e
    Informamos o token de acesso recebido

  • [GET] https://gateway.apiserpro.serpro.gov.br/consulta-cnpj-trial/v1/cnpj/34238864000168
    Chamamos a url da API e o método desejado. No caso, a url base é "https://gateway.apiserpro.serpro.gov.br/consulta-cnpj-df-trial/v1/”, e o método é o "cnpj/34238864000168".

Exemplo de resposta esperada:

{
"ni": "34238864000168",
"data_abertura": "1967-06-30",
"nome_empresarial": "SERVICO DE E-COMERCE LTDA",
"nome_fantasia": "E-COMERCE",
"cnae_principal": {
    "codigo": "6204000",
    "descricao": "Consultoria em e-comerce"
},
"natureza_juridica": {
    "codigo": "2011",
    "descricao": "Empresa Pública"
},
"endereco": {
    "logradouro": "ST DE GRANDE AREA NORTE",
    "numero": "Q.601",
    "complemento": "LOTE V",
    "cep": "70836900",
    "bairro": "ASA NORTE",
    "municipio": "BRASILIA",
    "uf": "DF"
},
"situacao_especial": "",
"situacao_cadastral": {
    "codigo": "1",
    "data": "2004-05-22",
    "motivo": ""
},
"orgao": "0110100",
"tipo_estabelecimento": "1",
"correio_eletronico": "",
"capital_social": 0,
"porte": "05",
"telefones": [
    {
    "ddd": "061",
    "numero": "4338456"
    }
],
"nome_orgao": "BRASILIA",
"ente_federativo": "BR"
}

IMPORTANTE

A chamada à consulta da API CNPJ Trial acima é apenas para demonstração. As APIs disponíveis e suas respectivas URLs (endpoints) para consumo são disponibilizadas através da documentação dos seus respectivos swaggers. O gateway interpreta as letras maiúsculas e minúsculas de forma diferente. Certifique-se de enviar os endpoints conforme Referência da API sem alterar para maiúsculo ou minúsculo qualquer parte do endpoint.

Como utilizar a API CNPJ Demonstração

API CNPJ Demonstração é o ambiente de testes da API CNPJ, com dados de exemplo (Mock), com objetivo de demonstrar o funcionamento da API. Para utilizá-lo:

  1. Acesse a API CNPJ Demonstração V1 ou API CNPJ Demonstração V2
  2. Copie as informações de chave do ambiente trial (texto em negrito Bearer xxx...)
  3. Clique em Authorize
  4. Cole a chave copiada no campo "value" e em seguida no botão Authorize e depois em Close
  5. Escolha o método (endpoint) a testar
  6. Clique em Try it Out
  7. Insira os cabeçalhos que desejar e/ou altere o conteúdo do corpo da requisição
  8. Clique em Execute

Dados para testes

Para testar o ambiente Trial, utilize um dos CNPJ fictícios listados abaixo:

          CNPJ    CNPJ - BÁSICO       CNPJ - QSA CNPJ - EMPRESA
34238864000168 34238864000168 34238864000168 34238864000168
54447820000155 54447820000155 54447820000155 54447820000155
46768703000165
31151791000184
34428654000132
06115832000130
78078291000128
52293473000128
07781066000105
60367129000164