API / Exportação

Expo​rtação

O Portal da Transparência possibilita a exportação de conteúdo de consultas em arquivos nos formatos PDF, XLS e CSV, através da utilização de url e parâmetros de uma consulta JSON na ferramenta de relatórios do Portal.

 

Como funciona?

Para fazer download de uma consulta de detalhes de servidor ativo, por exemplo, basta utilizar a consulta JSON disponível na API de Pessoal e requisitar esta consulta na url do Transparência Relatórios, acrescentando o parâmetro tipo (pdf, xls ou csv), como descrito abaixo:

 

JSON http://transparencia.al.gov.br/pessoal/json-perfil-servidor/11475/?limit=2&offset=0
RELATÓRIOS http://transparencia.al.gov.br:8080/transparencia_relatorios/pessoal/json-perfil-servidor/11475/?limit=2&offset=0&tipo=xls

 

Apenas acrescentamos a parte destacada em negrito (:8080/transparencia_relatorios), que nos redireciona ao serviço de relatórios do Portal e o parâmetro tipo, neste caso, com o valor xls. Se o parâmetro tipo não for informado, o arquivo será gerado por padrão no formato PDF.

Observação: Para a exportação, o parâmetro limit é descartado e sempre serão retornados todos os resultados disponíveis.

 

Entendendo a requisição

Agora vamos explicar como funciona esta requisição.

 

:8080 Porta que atende o serviço de relatórios do Portal. Ao adicionar na URL, direcionamos a requisição para o serviço que queremos realizar.
/transparencia_relatorios Definimos qual serviço queremos acessar: o Transparência Relatórios.
tipo Parâmetro que define qual tipo de arquivo retornará através da requisição. Valores: PDF, XLS ou CSV.
TENHA ACESSO ÀS INFORMAÇÕES ATRAVÉS DE DADOS ABERTOS
2007-2022. Conteúdo e dados do Portal da Transparência licenciados sob Licença Creative Commons Licença Creative Commons BY-SA Open Data