Documentação da API

Documentação Interativa (Swagger)

Para uma experiência interativa completa com a API, acesse nossa documentação Swagger onde você pode testar os endpoints diretamente no navegador.

Acessar API Docs (Swagger)

Início Rápido

A API ClassiFisco permite classificar produtos e serviços automaticamente usando inteligência artificial. Aqui está um exemplo básico de como começar:

curl -X POST "https://classifisco.com/api/v1/classify" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -d '{
    "description": "Cerveja Heineken 350ml lata",
    "format": "json"
  }'
        

Nota: Você precisa de uma API Key válida para usar a API. Cadastre-se gratuitamente para obter sua chave.

Recursos da API

Classificação Inteligente

Classificação automática de produtos e serviços com precisão de 95% usando IA avançada.

Resposta Rápida

Respostas em menos de 2 segundos para a maioria das classificações.

Seguro e Confiável

Autenticação via API Key e dados criptografados em trânsito.

Analytics

Acompanhe suas classificações e performance através do dashboard.

Endpoints Principais

POST /api/v1/classify

Classifica um produto ou serviço e retorna o código NCM/NBS correspondente.

Parâmetros:

description (string, obrigatório): Descrição do produto ou serviço
format (string, opcional): Formato da resposta ("json" ou "html")

Exemplo de Resposta:

{
  "result_code": "2203.00.00",
  "result_type": "NCM",
  "description": "Cervejas de malte",
  "confidence": 95.2,
  "method_used": "tfidf",
  "explanation": "Produto classificado como cerveja de malte baseado na descrição..."
}
            

GET /api/v1/history

Retorna o histórico de classificações do usuário.

Parâmetros de Query:

page (int, opcional): Número da página (padrão: 1)
limit (int, opcional): Itens por página (padrão: 20)

GET /api/v1/api-keys

Lista as API Keys do usuário.

Autenticação

A API ClassiFisco usa autenticação baseada em API Keys. Inclua sua chave no header de autorização:

Authorization: Bearer sua_api_key_aqui

Importante: Mantenha sua API Key segura e nunca a compartilhe publicamente.

Limites de Taxa

Os limites de taxa variam conforme seu plano:

Plano	Classificações/Mês	Requests/Minuto
Gratuito	100	10
Básico	1.000	30
Profissional	10.000	60
Empresarial	Ilimitado	120

Documentação Interativa

Teste a API diretamente no seu navegador usando nossa documentação interativa:

Abrir Swagger UI

Dica: A documentação interativa permite testar todos os endpoints diretamente no navegador.

SDKs e Bibliotecas

Exemplos de integração em diferentes linguagens:

Python

import requests

response = requests.post(
    'https://classifisco.com/api/v1/classify',
    headers={'Authorization': 'Bearer SUA_API_KEY'},
    json={'description': 'Cerveja Heineken 350ml'}
)

result = response.json()
print(result['result_code'])
                

JavaScript

const response = await fetch('https://classifisco.com/api/v1/classify', {
    method: 'POST',
    headers: {
        'Authorization': 'Bearer SUA_API_KEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        description: 'Cerveja Heineken 350ml'
    })
});

const result = await response.json();
console.log(result.result_code);
                

Suporte

Precisa de ajuda com a integração? Nossa equipe está aqui para ajudar:

Email

suporte@classifisco.com

FAQ

Perguntas Frequentes