Acesso automatizado por sistemas externos

Introdução

O Tribunal Regional Federal da 5ª Região disponibiliza uma API REST denominada API Transparência, a qual permite a consulta a diversos tipos de documentos publicados no Portal do TRF5 em formato aberto, estruturável e legível por máquina (JSON), sem exigência de acesso ou necessidade de autenticação.

Abaixo segue um exemplo dos dados retornados pela API:

{
    // Indica se a requisição foi realizada com sucesso (OK) ou não (ERRO)
    "status": "OK",
    // Retorna o código HTTP da requisição (200 indica uma requisição bem-sucedida)
    "codigo": 200, 
    // Mensagem com detalhes sobre a requisição
    "mensagem": "Consulta realizada com sucesso", 
    // Campo que armazena o resultado da requisição; varia de acordo com o endpoint usado,    
    // podendo retornar tanto uma lista de valores quanto um único valor
    "resultado": []
}

Para obter uma lista dos documentos suportados pela API, utilize o endpoint abaixo:

GET https://api-transparencia.trf5.jus.br/api/v1/documento/tipo

Dado um determinado tipo de documento (por exemplo, o tipo 51 - Editais de Eliminação), podem ser utilizados os endpoints abaixo:

• Retonar os períodos em que há documentos publicados:

GET https://api-transparencia.trf5.jus.br/api/v1/documento/51/periodos

• Retornar a data de publicação mais recente:

GET https://api-transparencia.trf5.jus.br/api/v1/documento/51/dataAtualizacao

• Retornar os documentos publicados em determinado período:

GET https://api-transparencia.trf5.jus.br/api/v1/documento/51?dataInicio=2025-01-01&dataFim=2025-01-31

• Retornar os documentos publicados em determinado ano:

GET https://api-transparencia.trf5.jus.br/api/v1/documento/51?ano=2025

Exemplos de documentos suportados pela API