Objetivo

Esta API permite automatizar o cadastro de emissores no sistema Frontier da LAQUS, incluindo enriquecimento de dados via Receita Federal e Uplexis.

Base URL

http://localhost:5000/api

Fluxo de Trabalho

  1. Criar emissor com dados básicos (CNPJ, Razão Social)
  2. Enriquecer dados via Receita Federal (opcional)
  3. Buscar representantes legais via Uplexis (opcional)
  4. Fazer upload de documentos
  5. Cadastrar no Frontier (API externa)

Formatos de Resposta

Todas as respostas são retornadas em formato JSON.

{ "success": true, "data": {...}, "message": "Operação realizada com sucesso" }
POST /auth/login Realizar login

Autentica um usuário e retorna um token de sessão.

Parâmetros do Body
username string obrigatório
Nome de usuário
password string obrigatório
Senha do usuário
Exemplo de Resposta
{ "success": true, "user": { "id": 1, "username": "admin", "nome": "Administrador" } }
GET /auth/check Verificar autenticação

Verifica se o usuário está autenticado na sessão atual.

Exemplo de Resposta
{ "authenticated": true, "user": { "id": 1, "username": "admin" } }
POST /emissor Criar novo emissor

Cria um novo emissor no sistema com dados básicos.

Parâmetros do Body
cnpj string obrigatório
CNPJ do emissor (com ou sem formatação)
razao_social string obrigatório
Razão social do emissor
email string opcional
Email de contato
Exemplo de Resposta
{ "success": true, "emissor": { "id": 1, "cnpj": "12345678000190", "razao_social": "Empresa Exemplo LTDA", "email": "contato@exemplo.com" } }
GET /emissor/{id} Obter emissor

Retorna os dados de um emissor específico.

Parâmetros da URL
id integer obrigatório
ID do emissor
PUT /emissor/{id} Atualizar emissor

Atualiza os dados de um emissor existente.

DELETE /emissor/{id} Remover emissor

Remove um emissor do sistema.

POST /representante Criar representante

Adiciona um representante legal a um emissor.

Parâmetros do Body
emissor_id integer obrigatório
ID do emissor
nome string obrigatório
Nome completo do representante
cpf string obrigatório
CPF do representante
GET /emissor/{id}/representantes Listar representantes

Lista todos os representantes de um emissor.

Restrições de Upload
  • Formatos suportados: PDF, JPG, PNG
  • Tamanho máximo: 10MB por arquivo
  • Nome do arquivo: Apenas caracteres alfanuméricos, hífens e underlines
POST /emissor/documentos/upload Upload de documentos

Faz upload de documentos para um emissor.

Parâmetros (multipart/form-data)
emissor_id integer obrigatório
ID do emissor
files file[] obrigatório
Arquivos para upload (múltiplos)
DELETE /emissor/{id}/documentos/limpar Limpar documentos

Remove todos os documentos de um emissor.

POST /receita/consultar Consultar CNPJ

Consulta dados de um CNPJ na Receita Federal e enriquece os dados do emissor.

Parâmetros do Body
emissor_id integer obrigatório
ID do emissor
Dados Retornados

A consulta retorna: endereço completo, situação cadastral, capital social, atividade econômica principal, entre outros.

POST /uplexis/consultar Buscar representantes

Busca representantes legais de um CNPJ na base Uplexis.

Parâmetros do Body
emissor_id integer obrigatório
ID do emissor
Representantes Encontrados

Os representantes são automaticamente adicionados ao emissor com seus dados completos (nome, CPF, qualificação).

POST /frontier/cadastrar Cadastrar no Frontier

Envia os dados do emissor para cadastro no sistema Frontier (API externa da LAQUS).

Parâmetros do Body
emissores_ids integer[] obrigatório
Array com IDs dos emissores a cadastrar
ambiente string obrigatório
Ambiente Frontier: sandbox, homolog ou production
Pré-requisitos

Antes de cadastrar no Frontier, certifique-se de que:

  • Dados do emissor estão completos
  • Representantes legais foram adicionados
  • Documentos foram enviados