SISPAT - API de Bens Patrimoniais v2.3.0

O acesso ao SisPAT é realizado exclusivamente através do Login Único Gov.BR.

Ambiente de Produção

1. Acesse o SisPAT em prd-apex.antaq.gov.br/ords/r/sfc/sispat/ e clique em "Entrar com Gov.BR"
2. Informe seu CPF e senha do Gov.BR
3. Após autenticado, navegue até "Gerenciador de API"
4. Gere uma nova credencial

Ambiente de Homologação (Sandbox)

Para utilizar o ambiente de homologação, é necessário criar uma conta no ambiente de staging do Login Único Gov.BR:

1. Acesse sso.staging.acesso.gov.br
2. Informe o CPF
3. Concorde com os termos de uso
4. No passo de validação por reconhecimento facial, escolha "Não tenho celular" e na tela seguinte clique em "Tentar de outra forma"
5. Use os dados pessoais fictícios abaixo para validação:
   • Data de nascimento: 01/01/1980
   • Nome da mãe: MAMAE
6. Cadastre uma senha conforme as orientações demonstradas
7. Informe um e-mail ou telefone celular para confirmação do cadastro

Após o cadastro, acesse o SisPAT Sandbox em des-apex.antaq.gov.br/ords/r/sfc_dev/sispat/ e clique em "Entrar com Gov.BR". Navegue até "Gerenciador de API" e gere uma credencial de teste.

Acesso para Empresas de Tecnologia

Empresas de tecnologia interessadas em desenvolver soluções integradas ao SisPAT podem solicitar acesso ao ambiente de homologação (Sandbox) para estudar e testar a API.

Para isso, envie um e-mail para inventario@antaq.gov.br com as seguintes informações do representante responsável:

• Nome completo
• CPF
• E-mail corporativo
• CNPJ da empresa

Controles de Segurança

Controle	Implementação
Transporte seguro	HTTPS obrigatório em todos os endpoints; HTTP rejeitado
Autenticação	API Key individual por empresa, vinculada ao CNPJ
Autorização	Chave só opera sobre dados do CNPJ ao qual está vinculada
Isolamento de ambientes	Produção e Sandbox com chaves e bases de dados separadas
Rotação de credenciais	API Keys podem ser revogadas e recriadas a qualquer momento
Rastreabilidade	Todas as operações de escrita são registradas com log estruturado

Antes de iniciar a integração, valide o acesso ao ambiente de desenvolvimento:

cURL (Terminal/CMD)

curl -X GET "https://des-apex.antaq.gov.br/ords/sfc_sispat/sispat/bens/" \
     -H "x-api-key: sispat_test_SUA_CHAVE_TESTE" \
     -H "Accept: application/json"

PowerShell (Windows)

Invoke-RestMethod -Uri "https://des-apex.antaq.gov.br/ords/sfc_sispat/sispat/bens/" `
    -Headers @{"x-api-key"="sispat_test_SUA_CHAVE_TESTE"; "Accept"="application/json"}

A operação GET retorna todos os bens patrimoniais vinculados à sua API Key.

JavaScript (Fetch API)

fetch('https://prd-apex.antaq.gov.br/ords/sfc_sispat/sispat/bens/', {
    method: 'GET',
    headers: {
        'x-api-key': 'sispat_live_SUA_CHAVE_AQUI',
        'Accept': 'application/json'
    }
})
.then(response => response.json())
.then(data => {
    console.log('Total de registros:', data.pagination.total_records);
    console.log('Bens:', data.items);
})
.catch(error => console.error('Erro:', error));

Python (requests)

import requests

url = "https://prd-apex.antaq.gov.br/ords/sfc_sispat/sispat/bens/"
headers = {
    "x-api-key": "sispat_live_SUA_CHAVE_AQUI",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    data = response.json()
    print(f"Total de registros: {data['pagination']['total_records']}")
    for bem in data['items']:
        print(f"- {bem['numero_registro_patrimonial']}: {bem['nome_item']}")
else:
    print(f"Erro {response.status_code}: {response.text}")

C# (.NET HttpClient)

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "sispat_live_SUA_CHAVE_AQUI");
client.DefaultRequestHeaders.Add("Accept", "application/json");

var response = await client.GetAsync("https://prd-apex.antaq.gov.br/ords/sfc_sispat/sispat/bens/");
var json = await response.Content.ReadAsStringAsync();

Console.WriteLine(json);

A operação PUT utiliza lógica de Upsert: cria se não existir, atualiza se já existir.

cURL

curl -X PUT "https://prd-apex.antaq.gov.br/ords/sfc_sispat/sispat/bens/" \
     -H "x-api-key: sispat_live_SUA_CHAVE_AQUI" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -d '{
       "cnpj": 4903587000108,
       "numero_registro_patrimonial": "PAT-2024-0001",
       "numero_do_contrato": "CT-2024-001",
       "cod_trigrama": "GND",
       "nome_item": "Guindaste portuário",
       "capitulo": 84,
       "posicao": 8427,
       "subposicao": 842710,
       "especificacao_tecnica": "Guindaste móvel sobre pneus, capacidade 50t",
       "cor": "Amarelo",
       "fornecedor": "Liebherr Brasil",
       "capacidade": 50,
       "unidade_de_medida": 16,
       "latitude": -23.9618,
       "longitude": -46.3322,
       "destinacao": "Operação portuária",
       "modalidade_de_tombamento": 1,
       "data_de_tombamento": "2024-01-15",
       "valor_original_de_compra": 1500000.00,
       "fonte_de_recurso": 1,
       "valor_justo_de_mercado": 1400000.00,
       "valor_residual": 150000.00,
       "vida_util_anos": 20,
       "taxa_depreciacao": 5.00,
       "data_de_avaliacao": "2024-01-15",
       "conta_contabil": "10.1.2.01",
       "historico": 1,
       "situacao": 1,
       "estado_de_conservacao": 3,
       "bem_da_uniao": 2,
       "bem_reversivel": 1,
       "natureza": 1,
       "vinculacao_contratual": 2,
       "tipo_de_bem": 5,
       "grupo_de_bens": 4,
       "sigla_uf": "SP"
     }'

JavaScript (Fetch API)

const bem = {
    cnpj: 4903587000108,
    numero_registro_patrimonial: "PAT-2024-0001",
    numero_do_contrato: "CT-2024-001",
    nome_item: "Guindaste portuário",
    // ... demais campos obrigatórios
};

fetch('https://prd-apex.antaq.gov.br/ords/sfc_sispat/sispat/bens/', {
    method: 'PUT',
    headers: {
        'x-api-key': 'sispat_live_SUA_CHAVE_AQUI',
        'Content-Type': 'application/json',
        'Accept': 'application/json'
    },
    body: JSON.stringify(bem)
})
.then(response => {
    if (response.status === 200) {
        console.log('Bem ATUALIZADO com sucesso');
    } else if (response.status === 201) {
        console.log('Bem CRIADO com sucesso');
    }
    return response.json();
})
.then(data => console.log(data));

Envia uma foto para um bem patrimonial já cadastrado.

cURL

curl -X POST "https://prd-apex.antaq.gov.br/ords/sfc_sispat/sispat/bens/imagem" \
     -H "x-api-key: sispat_live_SUA_CHAVE_AQUI" \
     -H "X-Numero-Registro-Patrimonial: PAT-2024-0001" \
     -H "Content-Type: image/jpeg" \
     -H "X-Filename: guindaste_foto_01.jpg" \
     --data-binary @/caminho/para/foto.jpg

JavaScript (Fetch API)

const numRegPat = "PAT-2024-0001";
const fileInput = document.getElementById('fileInput');
const file = fileInput.files[0];

fetch('https://prd-apex.antaq.gov.br/ords/sfc_sispat/sispat/bens/imagem', {
    method: 'POST',
    headers: {
        'x-api-key': 'sispat_live_SUA_CHAVE_AQUI',
        'X-Numero-Registro-Patrimonial': numRegPat,
        'Content-Type': file.type,
        'X-Filename': file.name
    },
    body: file
})
.then(response => response.json())
.then(data => {
    console.log('Upload realizado:', data);
    console.log('Tamanho:', data.data.size_formatted);
})
.catch(error => console.error('Erro:', error));

Python (requests)

import requests

num_reg_pat = "PAT-2024-0001"
arquivo = "/caminho/para/foto.jpg"

url = "https://prd-apex.antaq.gov.br/ords/sfc_sispat/sispat/bens/imagem"

with open(arquivo, 'rb') as f:
    headers = {
        "x-api-key": "sispat_live_SUA_CHAVE_AQUI",
        "X-Numero-Registro-Patrimonial": num_reg_pat,
        "Content-Type": "image/jpeg",
        "X-Filename": "guindaste_foto_01.jpg"
    }
    response = requests.post(url, headers=headers, data=f)

if response.status_code == 200:
    data = response.json()
    print(f"Upload realizado: {data['data']['filename']}")
    print(f"Tamanho: {data['data']['size_formatted']}")
else:
    print(f"Erro {response.status_code}: {response.text}")

C# (.NET HttpClient)

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "sispat_live_SUA_CHAVE_AQUI");
client.DefaultRequestHeaders.Add("X-Numero-Registro-Patrimonial", "PAT-2024-0001");
client.DefaultRequestHeaders.Add("X-Filename", "guindaste_foto_01.jpg");

var url = "https://prd-apex.antaq.gov.br/ords/sfc_sispat/sispat/bens/imagem";

var imageBytes = await File.ReadAllBytesAsync("/caminho/para/foto.jpg");
var content = new ByteArrayContent(imageBytes);
content.Headers.ContentType = new MediaTypeHeaderValue("image/jpeg");

var response = await client.PostAsync(url, content);
var json = await response.Content.ReadAsStringAsync();

Console.WriteLine(json);

O campo opcional numero_registro_patrimonial_pai permite vincular um bem acessório (filho) a um bem principal (pai). Isso é útil para bens como sensores, válvulas ou componentes que possuem registros patrimoniais próprios mas estão fisicamente vinculados a um bem maior (tanques, guindastes, etc.).

A hierarquia é limitada a um único nível (pai → filho). Não é possível criar estruturas mais profundas (avô → pai → filho).

Regras de Validação

#	Regra	Exemplo
1	Não pode referenciar a si mesmo — o numero_registro_patrimonial_pai não pode ser igual ao numero_registro_patrimonial do próprio bem.	PAT-001 não pode ser pai de PAT-001.
2	Pai deve existir — o numero_registro_patrimonial_pai deve corresponder a um bem já cadastrado no mesmo CNPJ. O bem pai precisa ser criado antes do bem filho.	Se PAT-999 não existe, não pode ser referenciado como pai.
3	Pai não pode ser filho de ninguém — o bem apontado como pai não pode possuir um numero_registro_patrimonial_pai preenchido. Isso garante apenas um nível de hierarquia, bloqueando a criação de "netos".	Se PAT-002 já é filho de PAT-001, então PAT-002 não pode ser pai de PAT-003.
4	Bem com filhos não pode virar filho — um bem que já é referenciado como pai por outros bens não pode receber um numero_registro_patrimonial_pai. Isso impede a criação de hierarquia multinível "por cima".	Se PAT-001 já tem filhos, não pode ser vinculado como filho de PAT-010.

Exemplo de uso

Cadastre primeiro o bem principal (pai) e depois o bem acessório (filho) referenciando o pai:

// 1. Primeiro, cadastre o bem principal (pai)
PUT /sispat/bens/
{
    "cnpj": "04903587000108",
    "numero_registro_patrimonial": "PAT-2024-0001",
    "nome_item": "Guindaste portuário",
    ...
}

// 2. Depois, cadastre o bem acessório (filho) vinculando ao pai
PUT /sispat/bens/
{
    "cnpj": "04903587000108",
    "numero_registro_patrimonial": "PAT-2024-0001-A",
    "numero_registro_patrimonial_pai": "PAT-2024-0001",
    "nome_item": "Sensor de carga do guindaste",
    ...
}

Respostas de erro

Todas as violações das regras de hierarquia retornam HTTP 422:

// Auto-referência
{"status": 422, "error": "VALIDATION_ERROR",
 "message": "O bem não pode ser pai de si mesmo."}

// Pai inexistente
{"status": 422, "error": "VALIDATION_ERROR",
 "message": "Bem pai não encontrado. O número de registro patrimonial \"PAT-999\" não existe para este CNPJ."}

// Pai já é filho (tentativa de criar neto)
{"status": 422, "error": "VALIDATION_ERROR",
 "message": "O bem pai informado já é filho de outro bem. Apenas um nível de hierarquia é permitido (pai → filho)."}

// Bem com filhos tentando virar filho
{"status": 422, "error": "VALIDATION_ERROR",
 "message": "Este bem já possui bens filhos vinculados. Um bem pai não pode ser vinculado como filho de outro bem."}

Código	Status	Descrição
200	OK	Requisição bem-sucedida. No PUT, indica que o bem foi atualizado.
201	Created	Recurso criado com sucesso. No PUT, indica que o bem foi cadastrado.
400	Bad Request	Erro de validação: CNPJ inválido, campos obrigatórios faltando ou formato incorreto.
401	Unauthorized	API Key não fornecida, inválida ou inativa. Verifique suas credenciais.
403	Forbidden	API Key não tem permissão para operar com o CNPJ informado.
404	Not Found	Recurso não encontrado. No POST de imagem, indica que o bem não existe.
422	Unprocessable Entity	Dados semanticamente inválidos (ex: enum fora do range permitido).
500	Internal Server Error	Erro interno não tratado. Contate o suporte.

Campos que aceitam apenas valores específicos (enums):

modalidade_de_tombamento

Valor	Descrição
1	Aquisição
2	Comodato
3	Cessão
4	Permuta
5	Doação
6	Fabricação
7	Incorporação Prévia
8	Transferência
9	Encampação

fonte_de_recurso

Valor	Descrição
1	Próprio
2	Tesouro Nacional
3	Tesouro Estadual
4	Tesouro Municipal

historico

Valor	Descrição
1	Tombado
2	Não Tombado
3	Inexistente
4	Transferência União
5	Sem Transferência
6	Com Aceite
7	Sem Aceite

situacao

Valor	Descrição
1	Servível
2	Ocioso
3	Antieconômico
4	Recuperável
5	Irrecuperável

estado_de_conservacao

Valor	Descrição
1	Novo
2	Excelente
3	Bom
4	Regular
5	Péssimo

grupo_de_bens

Valor	Descrição
1	Terrenos
2	Edifícios e Benfeitorias
3	Instalações
4	Máquinas
5	Aparelhos
6	Equipamentos
7	Equipamentos de Informática
8	Sistemas Aplicativos (Softwares)
9	Móveis e Utensílios
10	Veículos
11	Ferramentas
12	Peças e Conjuntos de Reposição
13	Benfeitorias em Propriedades Arrendadas
14	Não Aplicável
15	Infraestrutura Marítima
16	Infraestrutura Acostagem
17	Infraestrutura Terrestre
18	Armazenagem
19	Equipamentos de Armazenagem
20	Outros Equipamentos

tipo_de_bem

Valor	Descrição
1	Bens da União - Administração
2	Bens da União - Operação
3	Bens da União - Terceiros
4	Bens de Terceiros
5	Bens da Administração
6	Bens em Operação
7	Imobilizado em Andamento
8	Benfeitorias úteis em Bens de Terceiros

unidade_de_medida

Valor	Descrição
1	Não definido
2	Caixa
3	Coleção
4	Conjunto
5	Equip.
6	Jogo
7	Kg
8	Km
9	Litro
10	M2
11	M3
12	Metro
13	Par
14	Parte
15	Peça
16	Tonelada
17	Unid.
18	Tonelada/hora (transportadores, elevadores de caneca)
19	kVA (transformadores elétricos)
20	m³/hora (bombas centrífugas)
21	CV (motores elétricos)

Campos binários (1=Sim, 2=Não)

• bem_da_uniao
• bem_reversivel
• natureza (1=Móvel, 2=Imóvel)
• vinculacao_contratual (1=Removível, 2=Não Removível)
• modalidade_exploracao (1=Autoridade Portuária, 2=Arrendatário)
• depreciacao_especial

Histórico das mudanças relevantes para integradores, mantido para transparência ativa com as entidades reguladas e suas equipes de TI. Mudanças que afetam contratos existentes são sinalizadas em destaque.

Abril/2026 — Atualização do dicionário tipo_de_bem (alinhamento ao SICRASP/2022)

• Novo valor adicionado ao dicionário tipo_de_bem:
  • 8 — Benfeitorias úteis em Bens de Terceiros.
• Renomeação de rótulos (os códigos numéricos foram preservados; só o texto descritivo mudou):
  • 5: Bens Próprios - Administração → Bens da Administração;
  • 6: Bens Próprios - Operação → Bens em Operação.
• Faixa aceita pela API passa de 1..7 para 1..8. A lista completa está na seção Dicionário de Campos Enumerados acima.
• Retrocompatível: bens já cadastrados com os códigos 5 e 6 permanecem válidos sem necessidade de atualização — apenas a interpretação textual do código mudou, em alinhamento à estrutura do imobilizado adotada pelo SICRASP a partir de 2022. Integrações existentes continuam funcionando sem ajuste.

Abril/2026 — Novas unidades de medida (equipamentos portuários)

• Adicionados quatro códigos ao dicionário unidade_de_medida para atender equipamentos típicos do setor portuário:
  • 18 — Tonelada/hora (transportadores e elevadores de caneca);
  • 19 — kVA (transformadores elétricos);
  • 20 — m³/hora (bombas centrífugas);
  • 21 — CV (motores elétricos).
• Faixa aceita pela API passa de 1..17 para 1..21. A lista completa está na seção Dicionário de Campos Enumerados acima.
• Retrocompatível: os códigos anteriores (1–17) permanecem inalterados. Integrações existentes continuam funcionando sem ajuste.

Abril/2026 — Vinculação de bens (hierarquia pai-filho)

• Novo campo opcional numero_registro_patrimonial_pai no PUT e GET para vincular bens acessórios (filhos) a um bem principal (pai).
• Hierarquia limitada a um único nível (pai → filho). Quatro regras de validação impedem auto-referência, pais inexistentes, criação de "netos" e transformação de pais existentes em filhos.
• Retrocompatível: o campo é opcional e nullable. Integrações existentes continuam funcionando sem alteração.

Abril/2026 — Tipagem numérica para capacidade e unidade_de_medida

• capacidade: agora número (inteiro ou decimal, ≥ 0). Envie 50 em vez de "50 toneladas".
• unidade_de_medida: agora inteiro de 1 a 17, vinculado ao dicionário oficial do APEX. Para "toneladas" use 16; para "metros cúbicos" use 11; consulte a tabela completa na seção Dicionário de Campos Enumerados acima.
• Retrocompatibilidade preservada para strings numéricas: a API ainda aceita valores enviados como string desde que sejam numericamente válidos — por exemplo "50" ou "16" são convertidos automaticamente. Apenas strings descritivas ("50 toneladas") são rejeitadas.
• Validação reforçada: CNPJs com mais de 14 dígitos e numero_registro_patrimonial acima de 50 caracteres agora retornam HTTP 400 com mensagem amigável (antes podiam cair em erro genérico do servidor).
• Ação recomendada para integradores: ajustar os clientes para enviar capacidade como número JSON puro e unidade_de_medida como inteiro do dicionário.

Março/2026 — Ferramenta web de importação em lote

• Nova interface para importação de bens via planilha Excel: upload.html. Inclui geração do modelo oficial, controle de envio em lote (com pausa, retomada e cancelamento) e relatório linha-a-linha do resultado.
• Validações locais executadas no navegador antes do envio à API, reduzindo idas e voltas:
  • Combinação NCM (capítulo + posição + subposição) contra a tabela SISPAT_SUBPOSICOES;
  • Conta contábil contra a tabela SISPAT_CONTA_CONTABIL;
  • Código trigrama de porto contra a tabela TB_PORTOS.
• Botão de exportação do contrato OpenAPI 3.0 disponível na navbar da documentação, facilitando geração de SDKs e mocks.
• Link para o Manual de Inventário Patrimonial adicionado à navegação principal.
• Correções na documentação interativa: tipos JSON, campos obrigatórios, exemplos coerentes e detecção robusta do cabeçalho da planilha.

Março/2026 — Padronização dos endpoints de imagem

• Os endpoints GET, PUT e POST de imagem foram padronizados para o mesmo formato de URL e cabeçalhos.
• Removido o identificador interno do banco da resposta da API: clientes que dependiam de id_cadastro_de_bens devem migrar para a chave natural.
• Correções em exemplos da documentação para refletir o novo contrato.

Janeiro/2026 — Lançamento da v2.1.0

• Novo endpoint POST /sispat/imagem/ para upload de foto vinculada a um bem patrimonial. Tamanho máximo de 5 MB; formatos aceitos: JPEG, PNG, GIF, WebP, BMP.
• Documentação interativa publicada com Swagger UI integrado, exemplos de cURL/JavaScript/Python e dicionário completo de campos enumerados.
• Padronização da lista oficial de unidades de medida e descrições de bens patrimoniais.

Para reportar incidentes, esclarecer dúvidas de integração ou solicitar funcionalidades, contate a equipe responsável pelo SisPAT em inventario@antaq.gov.br.