API legada/Referência completa/Integração ERP (1.0)

Consulta de crédito

Recebe um CNPJ e devolve o resultado da consulta de crédito, hoje sempre pendente porque a integração com o bureau não está ligada.

A 1.0 tinha uma consulta de crédito por CNPJ (um score de risco do cliente B2B, vindo de um bureau de crédito) que o ERP chamava antes de liberar um limite. Esta rota mantém o contrato para que o ERP não quebre, mas a integração com o bureau não está ligada nesta versão.

A rota só valida o formato do CNPJ (14 caracteres, com ou sem pontuação; as 12 primeiras posições podem ter letras, no novo CNPJ alfanumérico). Não confere os dígitos verificadores: 11.222.333/0001-99 passa. Exige credencial de administrador.

POST/api/v1.0/credit_scoreAdmin

Consultar o crédito de um CNPJ (API 1.0)

Corpo da requisição

cnpjstringobrigatório

CNPJ a consultar, com ou sem pontuação (11.222.333/0001-81 ou 11222333000181).

POST/api/credit_scoreAdmin

Mesma rota, sem o prefixo /v1.0

Idêntica à anterior em corpo e resposta.

POST/api/v1.0/creditscoreAdmin

Mesma rota, nome creditscore

Nome usado pelo app móvel da 1.0 (CreditScore). Idêntica à primeira em corpo e resposta.

POST/api/creditscoreAdmin

Nome creditscore, sem o prefixo /v1.0

Idêntica à anterior.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1.0/credit_score" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "cnpj": "11.222.333/0001-81"
}'

Resposta

200Consulta pendente

json

{
  "cnpj": "11.222.333/0001-81",
  "score": 0,
  "status": "pending",
  "message": "ClearSale integration not yet configured. ..."
}

Campos da resposta

cnpjstring

O CNPJ enviado, do jeito que veio.

scoreinteger

Sempre 0 nesta versão.

statusstring

pending

Sempre pending nesta versão.

messagestring

Aviso de que a integração não está configurada. Em inglês.

Erros

Status	Quando	Corpo
400	Corpo que não é JSON	`{"message":"Invalid JSON body","status":400}`
400	`cnpj` ausente ou vazio	`{"message":"cnpj is required","status":400}`
400	Formato de CNPJ inválido	`{"message":"Invalid CNPJ format","status":400}`
401	Sem credencial	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
403	Credencial que não é de administrador	`{"message":"Forbidden: admin scope required","status":403}`

Veja também