Documentação da API

Integre o poder do Sistema NCM em suas aplicações com nossa API simples e eficiente.

Autenticação

Para utilizar nossa API, você precisa de uma chave de API (API Key).

Como obter sua API Key:
Entre em contato conosco através do email [email protected] para solicitar sua chave de acesso personalizada.
Métodos de Autenticação

Inclua sua API Key em uma das seguintes formas:

1. Header Authorization (Recomendado):
Authorization: Bearer SUA_API_KEY_AQUI
2. Header X-API-Key:
X-API-Key: SUA_API_KEY_AQUI
3. Query Parameter (menos seguro):
GET /api/buscar_ncm?api_key=SUA_API_KEY_AQUI&termo=smartphone
Segurança: Mantenha sua API key segura e não a compartilhe. Use sempre HTTPS em produção.

Endpoints Disponíveis

GET /api/buscar_ncm

Busca códigos NCM por termo de pesquisa.

Parâmetros:
  • termo (string, obrigatório): Termo de busca
Exemplo de requisição:
GET /api/buscar_ncm?termo=smartphone
Resposta:
{
  "results": [
    {
      "codigo": "8517.12.31",
      "descricao": "Telefones móveis e outras redes sem fio",
      "unidade": "un",
      "capitulo": "84",
      "posicao": "8517"
    }
  ]
}

POST /api/consulta_ncm

Consulta inteligente usando IA para encontrar o NCM mais adequado.

Requer: API Key com permissão para acesso à IA
Parâmetros (JSON):
  • produto (string, obrigatório): Descrição do produto
Exemplo de requisição:
POST /api/consulta_ncm
Authorization: Bearer SUA_API_KEY_AQUI
Content-Type: application/json

{
  "produto": "smartphone Samsung Galaxy"
}
Resposta de sucesso:
{
  "success": true,
  "produto": "smartphone Samsung Galaxy",
  "recomendacao_ia": "Análise detalhada do especialista...",
  "palavras_chave": ["smartphone", "telefone", "celular"],
  "ncms_recomendados": [
    {
      "codigo": "8517.12.31",
      "descricao": "Telefones móveis...",
      "unidade": "un"
    }
  ],
  "total_encontrados": 5,
  "api_key_usage": {
    "requests_today": 45,
    "requests_this_minute": 2,
    "limit_per_minute": 60,
    "limit_per_day": 1000
  },
  "timestamp": "2025-08-02T10:30:00"
}
Resposta de erro:
{
  "success": false,
  "error": "Rate limit exceeded",
  "message": "Limite de 60 req/min excedido"
}

POST /consulta_ncm

Consulta inteligente via interface web (não requer API key).

Parâmetros (JSON):
  • texto (string, obrigatório): Descrição do produto
Exemplo de requisição:
POST /consulta_ncm
Content-Type: application/json

{
  "texto": "smartphone Samsung Galaxy"
}
Resposta:
{
  "sugestao": "Análise da IA...",
  "ncms_encontrados": [...],
  "palavras_chave": [...],
  "total_encontrados": 5
}
"description": "Telefones móveis e outras redes sem fio", "analysis": "Baseado na descrição...", "confidence": 0.95 }

GET /api/ncm

Obtém informações detalhadas de um código NCM específico.

Parâmetros:
  • codigo (string, obrigatório): Código NCM completo
Exemplo de requisição:
GET /api/ncm?codigo=8517.12.31

GET /api/ncm_tree

Obtém a estrutura hierárquica dos códigos NCM.

Parâmetros:
  • level (string, opcional): Nível da hierarquia (capitulo, posicao, subposicao)
  • parent (string, opcional): Código pai para filtrar

Limites de Uso

  • Requisições por minuto: 60
  • Requisições por dia: 1000
  • Timeout: 30 segundos

Limites mais altos estão disponíveis para contas premium. Entre em contato para mais informações.

Suporte

Precisa de ajuda com a integração ou tem dúvidas sobre a API?

Email de suporte: [email protected]

Responderemos em até 24 horas úteis.