Como consumir a API de CNPJ em Python?

Prepare o ambiente

Use Python 3.10 ou superior. Crie uma pasta de exemplo e prepare o cliente HTTP.

1python -m pip install requests

Configure chave e projeto

Crie uma chave de Desenvolvimento no painel. O ping deste guia usa dev_mode=true: simula a resposta sem cobrança. A chave pública identifica sua integração; o segredo fica em uma variável de ambiente no servidor.

Defina as três variáveis no ambiente do terminal. Os valores abaixo são marcadores: substitua pela sua chave e pelo identificador real do projeto.

1$env:AFD_PUBLIC_KEY="afd_test_pk_..."
2$env:AFD_SECRET_KEY="seu_segredo_de_desenvolvimento"
3$env:AFD_PROJECT_ID="proj_..."

1export AFD_PUBLIC_KEY="afd_test_pk_..."
2export AFD_SECRET_KEY="seu_segredo_de_desenvolvimento"
3export AFD_PROJECT_ID="proj_..."

A autenticação HTTP Basic codifica public_key:secret_key em Base64. O cabeçalho X-Project-Id seleciona o projeto. Na consulta pública de CNPJ, nenhum desses cabeçalhos é necessário.

Execute a primeira chamada

Salve o exemplo em integracao.py. Ele faz duas chamadas: primeiro o ping autenticado em DEV; depois a consulta real e aberta do CNPJ de exemplo.

1import os
2import uuid
3import requests
4
5def read(response):
6    payload = response.json()
7    if not response.ok or not payload.get("success"):
8        codes = [e.get("code") for e in payload.get("errors", [])]
9        raise RuntimeError({"http": response.status_code, "codes": codes,
10                            "retry_after": response.headers.get("Retry-After")})
11    return payload
12
13# Mesma chave ao repetir esta operação lógica.
14operation_key = str(uuid.uuid4())
15ping = requests.get(
16    "https://api.apifordevs.com/api/v1/ping/billable?dev_mode=true",
17    auth=(os.environ["AFD_PUBLIC_KEY"], os.environ["AFD_SECRET_KEY"]),
18    headers={"X-Project-Id": os.environ["AFD_PROJECT_ID"],
19             "Idempotency-Key": operation_key}, timeout=30)
20print(read(ping))
21
22# Consulta real e pública: sem chave e sem modo DEV.
23response = requests.get("https://api.apifordevs.com/api/v1/cnpj/00000000007951", timeout=30)
24print(read(response)["data"][0])

1python integracao.py

Leia a resposta e os erros

O envelope inclui success, code, errors, header, data_count e data. No CNPJ, o primeiro resultado fica em data[0]. Confira found e reference_month antes de usar os campos.

Trate o status HTTP e errors[].code. Um CNPJ inválido retorna erro de validação; um CNPJ fora da base pode responder com sucesso e found: false. Ao receber HTTP 429, aguarde o período indicado em Retry-After. Não repita erros de validação sem corrigir a entrada.

Repita com segurança

O exemplo cria uma chave de operação. Nos endpoints que aceitam Idempotency-Key, reutilize o mesmo valor ao repetir a mesma operação lógica após uma falha de conexão. Uma operação nova recebe outra chave. Confira no detalhe do endpoint a janela e o comportamento de idempotência; o cabeçalho não transforma uma API sem suporte em idempotente.

Para testar esse comportamento, mantenha o valor de operationKey ou operation_key entre duas tentativas da mesma requisição. Não gere outro UUID dentro do loop de repetição. Respeite os limites mesmo quando repetir a operação.