Exemplo de retorno da api

PhysisNCM

PhysisNCM é uma API para classificação de produtos utilizando a Nomenclatura Comum do Mercosul (NCM). A API permite consultar o código NCM com base em descrições de produtos, utilizando inteligência artificial para análise e, opcionalmente, validação dos códigos por meio de uma tabela NCM local.

---

Funcionalidades

• Consulta NCM via OpenAI API:
  • Busca o código NCM mais adequado para a descrição do produto usando inteligência artificial.
• Validação com Tabela NCM:
  • Verifica a validade do código NCM retornado com base em uma tabela local.
• Fallback com Descrição Expandida:
  • Caso a descrição seja insuficiente, tenta expandi-la e buscar novamente.
• Cache de Consultas:
  • Implementa cache em memória para evitar consultas repetidas à API.
• Autenticação JWT:
  • Proteção de endpoints usando tokens JWT gerados pelo servidor.

---

Tecnologias Utilizadas

• .NET 6 / ASP.NET Core: Framework principal para a API.
• MemoryCache: Para caching em memória.
• OpenAI API: Para inteligência artificial.
• JWT: Para autenticação e segurança dos endpoints.
• FuzzySharp (opcional): Para busca baseada em similaridade.

---

Requisitos

• SDK do .NET 6 ou superior.
• Conta na OpenAI com chave de API válida.
• Tabela NCM em formato JSON (opcional para validação).

---

Instalação

1. Clone este repositório:

   git clone https://github.com/seu-usuario/PhysisNCM.git
   cd PhysisNCM

2. Restaure as dependências do projeto:

   dotnet restore

3. Configure sua chave de API no arquivo appsettings.json ou diretamente no código:

   {
       "OpenAI": {
           "ApiKey": "sua-chave-de-api"
       }
   }

4. Gere sua chave de API na plataforma OpenAI:

   • Acesse OpenAI API Keys.
   • Clique em "Create new secret key".
   • Copie a chave gerada e cole no arquivo appsettings.json ou na variável de ambiente correspondente.

5. Configure a autenticação JWT:

   • O endpoint /api/auth/login permite gerar tokens JWT para autenticação.
   • Exemplo de request:

     {
         "username": "admin",
         "password": "passowrd"
     }

   • Exemplo de resposta:

     {
         "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
     }

   • Utilize o token gerado para autenticar chamadas nos endpoints protegidos.

6. Adicione sua tabela NCM no diretório dados (opcional):

   • Exemplo de tabela:

     {
         "Nomenclaturas": [
             {
                 "Codigo": "8517.12.31",
                 "Descricao": "Celulares e aparelhos para comunicação sem fio",
                 "Data_Inicio": "01/01/2022",
                 "Data_Fim": "31/12/9999"
             }
         ]
     }

7. Execute o projeto:

   dotnet run --urls "http://localhost:8083"

---

Uso

Endpoints Disponíveis

POST /api/ncm/consulta

Consulta o código NCM baseado na descrição de um produto.

• Exemplo de Request:

  {
      "descricao": "Celular LG K12 Plus 32GB Android 8.1"
  }

• Exemplo de Resposta:

  {
      "descricao": "Celular LG K12 Plus 32GB Android 8.1",
      "ncm": "O código NCM mais adequado para o Celular LG K12 Plus 32GB com Android 8.1 é 8517.12.31.",
      "ncm_codigo": "8517.12.31",
      "aproximado": "Não, a classificação é precisa."
  }

POST /api/auth/login

Gera um token JWT para autenticação.

• Exemplo de Request:

  {
      "username": "admin",
      "password": "password"
  }

• Exemplo de Resposta:

  {
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }

Autenticação nos Endpoints Protegidos

Para usar endpoints protegidos, inclua o token JWT no cabeçalho da requisição:

Authorization: Bearer <seu-token-jwt>

---

Configuração do Cache

• A API utiliza o MemoryCache para armazenar os resultados por padrão por 10 minutos.
• O tempo de cache pode ser configurado no controlador (TimeSpan.FromMinutes(10)).

---

Estrutura do Projeto

PhysisNCM/
├── Controllers/
│   ├── NcmController.cs    # Controlador principal da API
│   └── AuthController.cs   # Controlador para autenticação JWT
├── Models/
│   ├── ProdutoRequest.cs   # Modelo para requisições de produtos
│   ├── LoginRequest.cs     # Modelo para login
│   └── NcmEntry.cs         # Modelo para a tabela NCM
├── Services/
│   └── NcmTableLoader.cs   # Serviço para carregar e validar a tabela NCM
├── appsettings.json        # Configurações da API
├── Program.cs              # Configuração e inicialização do projeto
├── dados/
│   └── Tabela_NCM.json     # Tabela NCM em JSON (opcional)

---

Próximos Passos

1. Cache Distribuído:

   • Substituir o MemoryCache por Redis para ambientes distribuídos.

2. Interface Gráfica:

   • Criar uma interface web para consultas manuais.

3. Melhoria de Busca:

   • Implementar correspondência mais robusta usando aprendizado de máquina ou algoritmos de similaridade.

4. Integração com Receita Federal:

   • Adicionar consulta direta à Receita Federal para validar códigos NCM.

---

Contribuição

Sinta-se à vontade para abrir issues ou pull requests para melhorar o projeto!

---

Licença

Este projeto está licenciado sob a MIT License. Consulte o arquivo LICENSE para mais detalhes.