-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.html
176 lines (166 loc) · 8.73 KB
/
api.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="">
<meta name="author" content="Alberto, ">
<title>Portal de Acesso à Informação</title>
<link href="bootstrap/css/bootstrap.min.css" rel="stylesheet">
<link href="bootstrap/css/bootstrap-theme.min.css" rel="stylesheet">
<link href="font-awesome/css/font-awesome.min.css" rel="stylesheet">
<link href="geral.css" rel="stylesheet">
</head>
<body>
<nav class="navbar navbar-inverse navbar-fixed-top">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">Portal de acesso à informação</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="index.html"><i class="fa fa-home" aria-hidden="true"></i> Início</a></li>
<li><a href="sobre.html"><i class="fa fa-info-circle" aria-hidden="true"></i> Sobre</a></li>
<li><a href="busca.html"><i class="fa fa-search" aria-hidden="true"></i> Buscar documento</a></li>
<li><a href="solicitacao.html"><i class="fa fa-envelope-open-o" aria-hidden="true"></i> Solicitar informação</a></li>
<li class="active"><a href="api.html"><i class="fa fa-desktop" aria-hidden="true"></i> Dados para desenvolvedores</a></li>
<li><a href="faq.html"><i class="fa fa-question-circle" aria-hidden="true"></i> Perguntas frequentes</a></li>
<li style="padding-left: 25px;"><a class="btn btn-primary font-resize" id="btn-decrease" href="#" role="button">A-</a></li>
<li><a class="btn btn-primary font-resize" id="btn-increase" href="#" role="button">A+</a></li>
<li><a class="btn btn-primary font-resize" id="btn-orig" href="#" role="button">A</a></li>
</ul>
</div><!--/.nav-collapse -->
</div>
</nav>
<div class="container-fluid" role="main">
<div class="row">
<div class="jumbotron">
<h1>Acesse os dados de forma fácil</h1>
<p>O nosso portal de transparência possui uma API para facilitar o seu programa a consumir os nossos dados.</p>
</div>
<nav class="col-sm-2 col-md-2 hidden-xs-down bg-faded sidebar">
<div class="panel panel-primary">
<div class="panel-heading">
<h2 class="panel-title">Sobre</h2>
</div>
<div class="panel-body">
<ul style="padding-left: 10px;">
<li class="spaced-list-item">Para consumir os nossos dados basta uma única chamada REST.</li>
<li class="spaced-list-item">Não conhece API's RESTFUL ou nunca trabalhou com JSON? <a href="#">Clique aqui</a> e entenda como funciona. </li>
</div>
</div>
</nav>
<main class="col-sm-9 offset-sm-2 col-md-9 offset-md-2">
<div class="container">
<h2>Acesso aos dados</h2>
<p>Para acessar os dados basta acessar o endereço: </p>
<div class="panel panel-default">
<div class="panel-body" id="panel-ip">
http://api.instituicao.gov.br/requisicao?tipo=<strong><TIPO></strong>&filtro=<strong><FILTRO></strong>.json
</div>
</div>
<p>Como destacado no endereço de chamada acima podesse escolher o tipo de dado que se deseja acessar e aplicar um filtro a este dado. Tipos de dados válidos, e seus filtros, são: </p>
<ul class="list-group">
<li class="list-group-item"><strong>Convenios:</strong> relaciona todos os convênios firmados pela instituição. TIPO: convenios, FILTRO:
<ul>
<li>ativos</li>
<li>encerrados</li>
<li>todos</li>
</ul>
</li>
<li class="list-group-item"><strong>Projetos:</strong> relaciona todos os projetos desenvolvidos pela instituição. TIPO: projetos, FILTRO:
<ul>
<li>ativos</li>
<li>encerrados</li>
<li>todos</li>
</ul>
</li>
<li class="list-group-item"><strong>Funcionarios:</strong> relaciona os funcionários da instituição. TIPO: funcionarios, FILTRO:
<ul>
<li>diretoria</li>
<li>gerencia</li>
<li>concursados</li>
<li>tercerizados</li>
<li>estagiarios</li>
</ul>
</li>
</ul>
<h4>Exemplo</h4>
<p>A chamada abaixo é um exemplo de chamada que retorna todos os convênios que estão ativos na instituição:
<div class="panel panel-default">
<div class="panel-body" id="panel-ip">
http://api.instituicao.gov.br/requisicao?tipo=<strong>convenios</strong>&filtro=<strong>ativos</strong>.json
</div>
</div>
<h2>Retorno obtido</h2>
<p>A API do portal de transparência retorna seus dados no formato JSON, sendo que este arquivo pode ser lido facilmente e é facilmente interpretado por programas simples. </p>
<p>Um exemplo de retorno válido para a solicitação acima é: </p>
<div class="panel panel-default">
<div class="panel-body" id="panel-ip">
{
"requisicao": {
"data_hora": "27-03-2017-09-33",
"dados_requisitados": "convenios",
"filtro": "ativos",
"registros": "3"
},
"dados": [{
"nome": "convenio1",
"id": "1",
"descricao": "descricao do convenio 1",
"situacao": "ativo"
"duracao_meses": "6"
"contrato": "arquivos.instituicao.gov.br/arquivos/convenio1.pdf"},
{
"nome": "convenio4",
"id": "4",
"descricao": "descricao do convenio 4",
"situacao": "ativo"
"duracao_meses": "3"
"contrato": "arquivos.instituicao.gov.br/arquivos/convenio4.pdf"},
{
"nome": "convenio11",
"id": "1",
"descricao": "descricao do convenio 11",
"situacao": "ativo"
"duracao_meses": "12"
"contrato": "arquivos.instituicao.gov.br/arquivos/convenio11.pdf"}]
}
</div>
</div>
</div>
</main>
</div>
</div>
<!-- FOOTER -->
<footer class="footer">
<div class="container">
<div class="row">
<div class="col-md-4 col-sm-6 footerleft ">
<h4> Endereço:</h4>
<p><i class="fa fa-map-marker" aria-hidden="true"></i> Campus Universitário Morro do Cruzeiro</p>
<p><i class="fa fa-university" aria-hidden="true"></i> Ouro Preto - MG, Brasil</p>
<p><i class="fa fa-address-book" aria-hidden="true"></i> CEP 35400-000 </p>
</div>
<div class="col-md-4 col-sm-6 footerleft " id="contato">
<h4> Contato:</h4>
<p><i class="fa fa-phone" aria-hidden="true"></i> Telefone: 31 3559-1692</p>
<p><i class="fa fa-envelope" aria-hidden="true"></i> Email: [email protected] </p>
<p><i class="fa fa-clock-o" aria-hidden="true"></i> Horário funcionamento: 08:00 - 12:00 / 13:00 - 17:00 </p>
</div>
</div>
</div>
</footer>
<!-- FIM DO FOOTER -->
<script src="js/jquery.min.js"></script>
<script src="bootstrap/js/bootstrap.min.js"></script>
<script src="js/utils.js"></script>
</body>
</html>