Documentação Api de Licitações V1

API de comunicação Contabilidade ⇄ Licitação

1. Introdução

A API de Licitações da E-Ticons é uma interface RESTful desenvolvida para integração entre os sistemas SisLicitacao e SisContabil, permitindo o gerenciamento centralizado de informações.

Esta API foi projetada com foco em segurança e uso interno, sendo acessível apenas dentro da infraestrutura da E-Ticons.
Todas as requisições seguem o padrão REST, utilizando os métodos HTTP GET, POST e PUT, e retornam respostas no formato JSON.

1.1 Endpoint Base

A API está hospedada internamente e pode ser acessada pelo endpoint base:

http://www.api-licitacao.eticons.com/v1 GET
Exemplo de Resposta
{
  "message": "Bem-vindo(a) à API REST de licitações da E-Ticons!",
  "support": "Para mais informações entre em contato conosco: https://www.eticons.com.br/contato"
}

2. Autenticação

Antes de consumir os demais endpoints, é necessário solicitar um Token de Acesso. Esse token deve ser incluído no Header Authorization das requisições.

2.1 Gerar Token:
http://www.api-licitacao.eticons.com/v1/token POST
Parâmetros (body JSON)
{
  "nome": "SisLicitacao",
}
Resposta de Sucesso
{
    "message": "Token cadastrado com sucesso!",
    "warning": "NÃO FORNCEÇA ESSE CÓDIGO PRA NINGUÉM E CERTIFIQUE-SE DE TER COPIADO. NÃO SERÁ POSSÍVEL CONSULTÁ-LO NOVAMENTE",
    "status": 200,
    "data": {
        "created_at": "2025-08-27T13:28:50.000000Z",
        "nome": "POSTMAN - TESTE",
        "descricao": null,
        "token": "kvEb4h4CBRuTCYTMG0Ctzj8ElGcOTNEdupCkJmZWFNeTrAEzc5aRRQABV8QL"
    }
}

3. Empresas

As empresas são utilizadas como ponto de identificação na API.
Todas as demais entidades (Autorizações de Fornecimento, Processos Licitatórios, etc.) são sempre vinculadas a uma empresa por meio do CNPJ.

3.1 Estrutura da Empresa

{
  "id": 1,
  "nome": "Prefeitura Municipal de João Pessoa",
  "cnpj": "12345678000199",
  "unidade_gestora": "001 - Administração Direta",
  "tipo_instituicao": 1,
  "tipo_instituicao_label": "Prefeitura",
  "created_at": "2025-08-20T12:00:00Z",
  "updated_at": "2025-08-27T10:00:00Z"
}
Enum tipo_instituicao
Tipo InstituiçãoValor
Prefeitura1
Autarquia2
Autarquia Estadual de Autonomia Mista3
Câmara de Vereadores4
Fundação5
Fundo6
Instituto de Previdência7
Consórcios8
    3.2 Endpoints principais
    Consultar Empresa por CNPJ
    http://www.api-licitacao.eticons.com/v1/empresa/{cnpj} GET
    Criar Empresa
    http://www.api-licitacao.eticons.com/v1/empresa POST
    Body:
    {
      "nome": "Prefeitura Municipal de João Pessoa",
      "cnpj": "12345678000199",
      "unidade_gestora": "001 - Administração Direta",
      "tipo_instituicao": 1
    }

    4. Autorizações de Fornecimento

    4.1 Consultar Autorizações
    http://www.api-licitacao.eticons.com/v1/autorizacoes-fornecimento/{cnpj} GET
    Parâmetros de rota

    cnpj (string) - CNPJ da empresa.

    Parâmetros de query opcionais (filtros):
    • numeroAutorizacao (integer)
    • dataAutorizacao (date: YYYY-MM-DD)
    • exercicioAutorizacao (string)
    • numeroLicitacao (string)
    • modalidadeLicitacao (integer)
    Resposta de Sucesso (200):
    [
      {
        "numeroAutorizacao": 123,
        "dataAutorizacao": "2025-08-20",
        "exercicioAutorizacao": "2025",
        "numeroLicitacao": "45/2025",
        "modalidadeLicitacao": 2,
        "valorTotal": 15000.50,
        "itens": [
          {
            "numeroLote": 1,
            "numeroItem": 10,
            "quantidade": 50,
            "valorUnitario": 300,
            "codigoTCE": "TCE-001"
          }
        ]
      }
    ]
    Erros:
    • 404 → Empresa não encontrada
    • 200 → [] (sem registros encontrados)
    4.2 Cadastrar Autorização
    http://www.api-licitacao.eticons.com/v1/autorizacao-fornecimento/{cnpj} POST
    Body JSON (exemplo):
    {
      "numeroAutorizacao": 123,
      "codigoUnidadeGestora": 101,
      "dataAutorizacao": "2025-08-27",
      "exercicioAutorizacao": "2025",
      "exercicioDotacao": "2025",
      "acao": "Reforma de Escola",
      "rubrica": "Obras Públicas",
      "fonteRecurso": "Municipal",
      "contratoAta": 456,
      "numeroLicitacao": "45/2025",
      "modalidadeLicitacao": 2,
      "exercicioLicitacao": "2025",
      "exercicioContratoAta": "2025",
      "numeroContratoAta": "123-A",
      "cnpjFornecedor": "12.345.678/0001-99",
      "valorTotal": 15000.50,
      "itens": [
        {
          "numeroLote": 1,
          "numeroItem": 10,
          "quantidade": 50,
          "valorUnitario": 300,
          "codigoTCE": "TCE-001"
        }
      ]
    }
    Resposta de Sucesso (200):
    {
      "message": "Autorização criada com sucesso.",
      "status": 200,
      "data": {
        "numeroAutorizacao": 123,
        "empresa_cnpj": "12345678000199",
        "valorTotal": 15000.5
      }
    }
    Erros:
    • 422 → Campos inválidos (retorna lista detalhada de erros)
    • 404 → Empresa não encontrada
    • 500 → Erro interno ao salvar
    4.3 Atualizar Autorização
    http://www.api-licitacao.eticons.com/v1/autorizacao-fornecimento/{cnpj} PUT

    Body JSON:

    Mesmos campos do cadastro.

    Resposta de Sucesso (200):
    {
      "message": "Autorização atualizacao com sucesso.",
      "status": 200,
      "data": {
        "numeroAutorizacao": 123,
        "empresa_cnpj": "12345678000199"
      }
    }
    Erros:
    • 404 → Empresa não encontrada
    • 422 → Validação falhou
    • 422 → Não foi possível atualizar a autorização