| 54
| <![CDATA[<div id="mw-content-text" lang="pt-BR" dir="ltr" class="mw-content-ltr"><table id="toc" class="toc"><tr><td><div id="toctitle"><h2>Índice</h2></div>
<ul>
<li class="toclevel-1 tocsection-1"><a href="#Apresenta.C3.A7.C3.A3o"><span class="tocnumber">1</span> <span class="toctext">Apresentação</span></a>
<ul>
<li class="toclevel-2 tocsection-2"><a href="#URI"><span class="tocnumber">1.1</span> <span class="toctext">URI</span></a></li>
<li class="toclevel-2 tocsection-3"><a href="#C.C3.B3digo_HTTP_de_Retorno"><span class="tocnumber">1.2</span> <span class="toctext">Código HTTP de Retorno</span></a></li>
</ul>
</li>
<li class="toclevel-1 tocsection-4"><a href="#Como_recuperar_dados_do_sistema_PROJPOP_atrav.C3.A9s_da_API"><span class="tocnumber">2</span> <span class="toctext">Como recuperar dados do sistema PROJPOP através da API</span></a></li>
<li class="toclevel-1 tocsection-5"><a href="#Recursos_Dispon.C3.ADveis"><span class="tocnumber">3</span> <span class="toctext">Recursos Disponíveis</span></a>
<ul>
<li class="toclevel-2 tocsection-6"><a href="#Dados"><span class="tocnumber">3.1</span> <span class="toctext">Dados</span></a>
<ul>
<li class="toclevel-3 tocsection-7"><a href="#Sintaxe_de_chamada_.27IQ.27.28Idade_Quinquenal.29_ou_.27SF.27.28Sem_Faixa.29"><span class="tocnumber">3.1.1</span> <span class="toctext">Sintaxe de chamada 'IQ'(Idade Quinquenal) ou 'SF'(Sem Faixa)</span></a></li>
<li class="toclevel-3 tocsection-8"><a href="#Retorno_JSON"><span class="tocnumber">3.1.2</span> <span class="toctext">Retorno JSON</span></a></li>
<li class="toclevel-3 tocsection-9"><a href="#Sintaxe_de_chamada_.27IE.27.28Idade_Escolar.29"><span class="tocnumber">3.1.3</span> <span class="toctext">Sintaxe de chamada 'IE'(Idade Escolar)</span></a></li>
<li class="toclevel-3 tocsection-10"><a href="#Retorno_JSON_2"><span class="tocnumber">3.1.4</span> <span class="toctext">Retorno JSON</span></a></li>
<li class="toclevel-3 tocsection-11"><a href="#Sintaxe_de_chamada_.27ESP.27.28Total_Estado_de_SP.29"><span class="tocnumber">3.1.5</span> <span class="toctext">Sintaxe de chamada 'ESP'(Total Estado de SP)</span></a></li>
<li class="toclevel-3 tocsection-12"><a href="#Retorno_JSON_3"><span class="tocnumber">3.1.6</span> <span class="toctext">Retorno JSON</span></a></li>
</ul>
</li>
<li class="toclevel-2 tocsection-13"><a href="#Tipos_de_Faixas_Et.C3.A1rias"><span class="tocnumber">3.2</span> <span class="toctext">Tipos de Faixas Etárias</span></a>
<ul>
<li class="toclevel-3 tocsection-14"><a href="#Sintaxe_de_chamada"><span class="tocnumber">3.2.1</span> <span class="toctext">Sintaxe de chamada</span></a></li>
<li class="toclevel-3 tocsection-15"><a href="#Retorno_JSON_4"><span class="tocnumber">3.2.2</span> <span class="toctext">Retorno JSON</span></a></li>
</ul>
</li>
<li class="toclevel-2 tocsection-16"><a href="#Tipos_de_Localidades"><span class="tocnumber">3.3</span> <span class="toctext">Tipos de Localidades</span></a>
<ul>
<li class="toclevel-3 tocsection-17"><a href="#Sintaxe_de_chamada_2"><span class="tocnumber">3.3.1</span> <span class="toctext">Sintaxe de chamada</span></a></li>
<li class="toclevel-3 tocsection-18"><a href="#Retorno_JSON_5"><span class="tocnumber">3.3.2</span> <span class="toctext">Retorno JSON</span></a></li>
</ul>
</li>
<li class="toclevel-2 tocsection-19"><a href="#Localidade"><span class="tocnumber">3.4</span> <span class="toctext">Localidade</span></a>
<ul>
<li class="toclevel-3 tocsection-20"><a href="#Sintaxe_de_chamada_3"><span class="tocnumber">3.4.1</span> <span class="toctext">Sintaxe de chamada</span></a></li>
<li class="toclevel-3 tocsection-21"><a href="#Retorno_JSON_6"><span class="tocnumber">3.4.2</span> <span class="toctext">Retorno JSON</span></a></li>
</ul>
</li>
<li class="toclevel-2 tocsection-22"><a href="#Ano"><span class="tocnumber">3.5</span> <span class="toctext">Ano</span></a>
<ul>
<li class="toclevel-3 tocsection-23"><a href="#Sintaxe_de_chamada_4"><span class="tocnumber">3.5.1</span> <span class="toctext">Sintaxe de chamada</span></a></li>
<li class="toclevel-3 tocsection-24"><a href="#Retorno_JSON_7"><span class="tocnumber">3.5.2</span> <span class="toctext">Retorno JSON</span></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</td></tr></table>
<h1> <span class="mw-headline" id="Apresenta.C3.A7.C3.A3o"> Apresentação </span></h1>
<p>A API, sigla em inglês para Interface de Programação de Aplicativos, foi desenvolvida para permitir a criação de aplicações, que tornem possível a visualização de informações das projeções populacionais, em outros sítios ou a reutilização em sistemas desenvolvidos por usuários, mediante acesso direto à base de informações, sempre atualizada, do PROJPOP – Projeções Populacionais. O formato, em código aberto, é o JSON e não há necessidade de cadastro ou qualquer outro procedimento para o acesso.
</p>
<h2> <span class="mw-headline" id="URI"> URI </span></h2>
<pre><a rel="nofollow" class="external free" href="http://api-projpop.seade.gov.br/v1">http://api-projpop.seade.gov.br/v1</a>
</pre>
<h2> <span class="mw-headline" id="C.C3.B3digo_HTTP_de_Retorno"> Código HTTP de Retorno </span></h2>
<ul><li> <b>Sucesso</b>: 200.
</li></ul>
<ul><li> <b>Erro</b>: 404.
</li></ul>
<h1> <span class="mw-headline" id="Como_recuperar_dados_do_sistema_PROJPOP_atrav.C3.A9s_da_API"> Como recuperar dados do sistema PROJPOP através da API </span></h1>
<p>Para programar a recuperação de dados do sistema, devem ser levadas em conta as três dimensões / parâmetros que são passíveis de seleção: faixa-etaria; localidade; sexo; cod_localidade; ano.
Caso a intenção seja recuperar todos os anos (dados) de uma dimensão / parâmetro ano , deve ser passado com all na sintaxe de comando. Ressalta-se que é indispensável a indicação de, todos os parâmetros exceto quando o parâmetro faixa-etaria for igaul 'IE'(Idade Escolar), nesse caso não é nescessário indicar o parâmetro sexo.</p>
<p><b>Sintaxe de chamada caso faixa-etaria seja igual a 'IQ'(Idade Quinquenal) ou 'SF'(Sem faixa etária):</b> <br />
http://api-projpop.seade.gov.br/v1/dados/A/B/C/D/E <br />
<b>onde A=faixa-etaria; B=localidade; C=sexo; D=cod_localidade; E=ano.</b>.</p>
<p><br />
</p>
<p><b>Sintaxe de chamada caso faixa-etaria seja igual a 'IE'(Idade Escolar):</b> <br />
http://api-projpop.seade.gov.br/v1/dados/A/B/C/D/E <br />
<b>onde A=faixa-etaria; B=localidade; C=cod_localidade; D=ano.</b>.</p>
<p><br />
</p>
<p><b>OBS:</b> Caso o parâmetro <b>B=localidade seja 'ESP'(Total Estado de SP)</b>, <b>o parâmetro cod_localidade deve ser igual a 0</b>, para se retornar todas as localidades das regiões, municípios, ras etc. Do estado de São Paulo.</p>
<h1> <span class="mw-headline" id="Recursos_Dispon.C3.ADveis"> Recursos Disponíveis </span></h1>
<h2> <span class="mw-headline" id="Dados"> Dados </span></h2>
<p><b>GET</b>
<b> Caso parâmetro faixa-etaria igual a 'IQ'(Idade Quinquenal) ou 'SF'(Sem Faixa):</b>
</p>
<ul><li> <b>Path</b>: /dados
</li><li> <b>Parâmetros</b>: faixa-etaria/localidade/sexo/cod-localidade/ano
</li></ul>
<p>* É obrigatório a informação todos os parâmetros.
</p><p>* Coloque all no parâmetro ano quando quiser trazer todos os anos.
</p>
<h3> <span class="mw-headline" id="Sintaxe_de_chamada_.27IQ.27.28Idade_Quinquenal.29_ou_.27SF.27.28Sem_Faixa.29"> Sintaxe de chamada 'IQ'(Idade Quinquenal) ou 'SF'(Sem Faixa) </span></h3>
<pre>curl -X GET "<a rel="nofollow" class="external free" href="http://api-projpop.seade.gov.br/v1/dados/iq/dc/t/80008/2016">http://api-projpop.seade.gov.br/v1/dados/iq/dc/t/80008/2016</a>"
</pre>
<p>ou
</p>
<pre>curl -X GET "<a rel="nofollow" class="external free" href="http://api-projpop.seade.gov.br/v1/dados/iq/dc/t/80008/all">http://api-projpop.seade.gov.br/v1/dados/iq/dc/t/80008/all</a>"
</pre>
<h3> <span class="mw-headline" id="Retorno_JSON"> Retorno JSON </span></h3>
<p>Exemplo:
</p>
<pre>{
</pre>
<pre> "dados": [
{
"ano": "2016",
"tipo_localizacao": "Distrito da Capital",
"cod_distrito_capital": "80008",
"nome": "Belém",
"tipo_faixa_etaria": "idade quinquenal",
"homes_00_a_04_anos": "2127",
"homes_05_a_09_anos": "1444",
"homes_10_a_14_anos": "1225",
"homes_15_a_19_anos": "1284",
"homes_20_a_24_anos": "1407",
"homes_25_a_29_anos": "1983",
"homes_30_a_34_anos": "2405",
"homes_35_a_39_anos": "2200",
"homes_40_a_44_anos": "1821",
"homes_45_a_49_anos": "1458",
"homes_50_a_54_anos": "1368",
"homes_55_a_59_anos": "1218",
"homes_60_a_64_anos": "1035",
"homes_65_a_69_anos": "735",
"homes_70_a_74_anos": "464",
"homes_75_anos_ou_mais": "814",
"mulheres_00_a_04_anos": "2037",
"mulheres_05_a_09_anos": "1403",
"mulheres_10_a_14_anos": "1208",
"mulheres_15_a_19_anos": "1313",
"mulheres_20_a_24_anos": "1358",
"mulheres_25_a_29_anos": "1803",
"mulheres_30_a_34_anos": "2208",
"mulheres_35_a_39_anos": "2136",
"mulheres_40_a_44_anos": "1741",
"mulheres_45_a_49_anos": "1527",
"mulheres_50_a_54_anos": "1561",
"mulheres_55_a_59_anos": "1437",
"mulheres_60_a_64_anos": "1323",
"mulheres_65_a_69_anos": "1047",
"mulheres_70_a_74_anos": "837",
"mulheres_75_anos_ou_mais": "1845",
"total_00_a_04_anos": "4164",
"total_05_a_09_anos": "2847",
"total_10_a_14_anos": "2433",
"total_15_a_19_anos": "2597",
"total_20_a_24_anos": "2765",
"total_25_a_29_anos": "3786",
"total_30_a_34_anos": "4613",
"total_35_a_39_anos": "4336",
"total_40_a_44_anos": "3562",
"total_45_a_49_anos": "2985",
"total_50_a_54_anos": "2929",
"total_55_a_59_anos": "2655",
"total_60_a_64_anos": "2358",
"total_65_a_69_anos": "1782",
"total_70_a_74_anos": "1301",
"total_75_anos_ou_mais": "2659",
"total_polpulacao_homem": "22988",
"total_polpulacao_mulher": "24784",
"total_geral_polpulacao": "47772"
}
]
</pre>
<p>}
</p><p><br /><br />
<b> Caso parâmetro faixa-etaria igual a 'IE'(Idade Escolar):</b>
</p>
<ul><li> <b>Path</b>: /dados
</li><li> <b>Parâmetros</b>: faixa-etaria/localidade/cod-localidade/ano
</li></ul>
<p>* É obrigatório a informação todos os parâmetros.
</p><p>* Coloque all no parâmetro ano quando quiser trazer todos os anos.
</p>
<h3> <span class="mw-headline" id="Sintaxe_de_chamada_.27IE.27.28Idade_Escolar.29"> Sintaxe de chamada 'IE'(Idade Escolar) </span></h3>
<pre>curl -X GET "<a rel="nofollow" class="external free" href="http://api-projpop.seade.gov.br/v1/dados/ie/dc/80008/2016">http://api-projpop.seade.gov.br/v1/dados/ie/dc/80008/2016</a>"
</pre>
<p>ou
</p>
<pre>curl -X GET "<a rel="nofollow" class="external free" href="http://api-projpop.seade.gov.br/v1/dados/ie/dc/80008/all">http://api-projpop.seade.gov.br/v1/dados/ie/dc/80008/all</a>"
</pre>
<h3> <span class="mw-headline" id="Retorno_JSON_2"> Retorno JSON </span></h3>
<p>Exemplo:
{
</p>
<pre> "dados": [
{
"ano": "2016",
"tipo_localizacao": "Distrito da Capital",
"cod_distrito_capital": "80008",
"nome": "Belém",
"tipo_faixa_etaria": "Idade Escolar",
"idade_escolar_00_a_03_anos": "3472",
"idade_escolar_04_a_05_anos": "1333",
"idade_escolar_06_anos": "597",
"idade_escolar_07_a_10_anos": "2105",
"idade_escolar_11_a_14_anos": "1937",
"idade_escolar_15_a_17_anos": "1545",
"idade_escolar_18_a_19_anos": "1052",
"total_idade_escolar": "12041",
"total_geral_polpulacao": "47772"
}
]
</pre>
<p>}
</p><p><br />
<br /><br />
<b> Caso parâmetro localidade igual a 'ESP'(Total Estado de SP):</b>
</p>
<ul><li> <b>Path</b>: /dados
</li><li> <b>Parâmetros</b>: faixa-etaria/localidade/cod-localidade/sexo/ano
</li></ul>
<p>* É obrigatório a informação todos os parâmetros.
</p><p>* Coloque all no parâmetro ano quando quiser trazer todos os anos.
</p>
<h3> <span class="mw-headline" id="Sintaxe_de_chamada_.27ESP.27.28Total_Estado_de_SP.29"> Sintaxe de chamada 'ESP'(Total Estado de SP) </span></h3>
<pre>curl -X GET "<a rel="nofollow" class="external free" href="http://api-projpop.seade.gov.br/v1/dados/iq/esp/t/0/2016">http://api-projpop.seade.gov.br/v1/dados/iq/esp/t/0/2016</a>"
</pre>
<p>ou
</p>
<pre>curl -X GET "<a rel="nofollow" class="external free" href="http://api-projpop.seade.gov.br/v1/dados/iq/esp/t/0/all">http://api-projpop.seade.gov.br/v1/dados/iq/esp/t/0/all</a>"
</pre>
<h3> <span class="mw-headline" id="Retorno_JSON_3"> Retorno JSON </span></h3>
<p>{
</p>
<pre> "dados": [
{
"ano": "2016",
"tipo_localizacao": "Total Estado de SP",
"tipo_faixa_etaria": "idade quinquenal",
"homes_00_a_04_anos": "1494089",
"homes_05_a_09_anos": "1380962",
"homes_10_a_14_anos": "1434816",
"homes_15_a_19_anos": "1664121",
"homes_20_a_24_anos": "1752414",
"homes_25_a_29_anos": "1860847",
"homes_30_a_34_anos": "1874874",
"homes_35_a_39_anos": "1736913",
"homes_40_a_44_anos": "1545931",
"homes_45_a_49_anos": "1418896",
"homes_50_a_54_anos": "1279657",
"homes_55_a_59_anos": "1111017",
"homes_60_a_64_anos": "889397",
"homes_65_a_69_anos": "656994",
"homes_70_a_74_anos": "444094",
"homes_75_anos_ou_mais": "555461",
"mulheres_00_a_04_anos": "1424776",
"mulheres_05_a_09_anos": "1330012",
"mulheres_10_a_14_anos": "1383635",
"mulheres_15_a_19_anos": "1611938",
"mulheres_20_a_24_anos": "1701665",
"mulheres_25_a_29_anos": "1832405",
"mulheres_30_a_34_anos": "1910127",
"mulheres_35_a_39_anos": "1826009",
"mulheres_40_a_44_anos": "1651313",
"mulheres_45_a_49_anos": "1530797",
"mulheres_50_a_54_anos": "1430412",
"mulheres_55_a_59_anos": "1275808",
"mulheres_60_a_64_anos": "1050142",
"mulheres_65_a_69_anos": "813888",
"mulheres_70_a_74_anos": "585107",
"mulheres_75_anos_ou_mais": "900488",
"total_00_a_04_anos": "2918865",
"total_05_a_09_anos": "2710974",
"total_10_a_14_anos": "2818451",
"total_15_a_19_anos": "3276059",
"total_20_a_24_anos": "3454079",
"total_25_a_29_anos": "3693252",
"total_30_a_34_anos": "3785001",
"total_35_a_39_anos": "3562922",
"total_40_a_44_anos": "3197244",
"total_45_a_49_anos": "2949693",
"total_50_a_54_anos": "2710069",
"total_55_a_59_anos": "2386825",
"total_60_a_64_anos": "1939539",
"total_65_a_69_anos": "1470882",
"total_70_a_74_anos": "1029201",
"total_75_anos_ou_mais": "1455949",
"total_polpulacao_homem": "21100483",
"total_polpulacao_mulher": "22258522",
"total_geral_polpulacao": "43359005"
}
]
</pre>
<p>}
</p>
<h2> <span class="mw-headline" id="Tipos_de_Faixas_Et.C3.A1rias"> Tipos de Faixas Etárias </span></h2>
<p><b>GET</b>
</p><p><br />
</p>
<ul><li> <b>Path</b>: /tipos-faixa-etaria
</li></ul>
<ul><li> <b>Parâmetros</b>: nenhum
</li></ul>
<ul><li> Retorna todos os tipos de faixas etárias existentes
</li></ul>
<p><br />
</p>
<h3> <span class="mw-headline" id="Sintaxe_de_chamada"> Sintaxe de chamada </span></h3>
<pre>curl -X GET "<a rel="nofollow" class="external free" href="http://api-imp.seade.gov.br/v1/tipos-faixa-etaria">http://api-imp.seade.gov.br/v1/tipos-faixa-etaria</a>"
</pre>
<p><br />
</p><p><br />
</p>
<h3> <span class="mw-headline" id="Retorno_JSON_4"> Retorno JSON </span></h3>
<p>Exemplo:
</p>
<pre>{
</pre>
<pre> "tipos-faixa-etaria": {
"IQ": "Idade Quinquenal",
"IE": "Idade Escolar",
"SF": "Sem Faixa Etária"
}
</pre>
<p>}
</p>
<h2> <span class="mw-headline" id="Tipos_de_Localidades"> Tipos de Localidades </span></h2>
<p><b>GET</b>
</p><p><br />
</p>
<ul><li> <b>Path</b>: /tipos-localidades
</li></ul>
<ul><li> <b>Parâmetros</b>: nenhum
</li></ul>
<ul><li> Retorna todos os tipos de localidades existentes.
</li></ul>
<p><br />
</p>
<h3> <span class="mw-headline" id="Sintaxe_de_chamada_2"> Sintaxe de chamada </span></h3>
<pre>curl -X GET "<a rel="nofollow" class="external free" href="http://api-imp.seade.gov.br/v1/tipos-localidades">http://api-imp.seade.gov.br/v1/tipos-localidades</a>"
</pre>
<h3> <span class="mw-headline" id="Retorno_JSON_5"> Retorno JSON </span></h3>
<p>Exemplo:
</p>
<pre>{
</pre>
<pre> "tipos-localidades": {
"DC": "Distritos da Capital",
"MUN": "Municípios",
"RA": "Região administrativa",
"RG": "Região de Governo",
"RM": "Região Metropolitana",
"DRS": "Departamento Regional de Saúde",
"ESP": "Total Estado de SP"
}
</pre>
<p>}
</p>
<h2> <span class="mw-headline" id="Localidade"> Localidade </span></h2>
<p><b>GET</b>
</p><p><br />
</p>
<ul><li> <b>Path</b>: /localidade
</li></ul>
<ul><li> <b>Parâmetros</b>: tipo-localidade, cod-localidade
</li></ul>
<p>Caso nescessário retornar todas as localidade daquele tipo deve se passar o parâmetro cod-localidade como 'ALL'.
</p><p><br />
</p>
<h3> <span class="mw-headline" id="Sintaxe_de_chamada_3"> Sintaxe de chamada </span></h3>
<pre>curl -X GET "<a rel="nofollow" class="external free" href="http://api-imp.seade.gov.br/v1/localidade/dc/{cod-localidade}">http://api-imp.seade.gov.br/v1/localidade/dc/{cod-localidade}</a>"
</pre>
<p>ou
</p>
<pre>curl -X GET "<a rel="nofollow" class="external free" href="http://api-imp.seade.gov.br/v1/localidade/dc/all">http://api-imp.seade.gov.br/v1/localidade/dc/all</a>"
</pre>
<p><br />
</p>
<h3> <span class="mw-headline" id="Retorno_JSON_6"> Retorno JSON </span></h3>
<p>Exemplo:
</p>
<pre>{
</pre>
<pre> "localidades": [
{
"codigo": "80003",
"nome": "Anhanguera",
"tipo_localizacao": "Distrito da Capital"
}
]
</pre>
<p>}
</p>
<h2> <span class="mw-headline" id="Ano"> Ano </span></h2>
<p><b>GET</b>
</p>
<ul><li> <b>Path</b>: /ano
</li><li> <b>Parâmetros</b>: nenhum
</li><li> Retorna todos os anos existentes na base.
</li></ul>
<p><br />
</p>
<h3> <span class="mw-headline" id="Sintaxe_de_chamada_4"> Sintaxe de chamada </span></h3>
<pre>curl -X GET "<a rel="nofollow" class="external free" href="http://api-imp.seade.gov.br/v1/ano">http://api-imp.seade.gov.br/v1/ano</a>"
</pre>
<p><br />
</p>
<h3> <span class="mw-headline" id="Retorno_JSON_7"> Retorno JSON </span></h3>
<p>Exemplo:
</p><p><br />
</p>
<pre>{
</pre>
<pre> "Anos": [
{
"ano": "2011"
},
{
"ano": "2012"
},
{
"ano": "2013"
},
{
"ano": "2014"
},
{
"ano": "2015"
},
{
"ano": "2016"
},
{
"ano": "2017"
},
{
"ano": "2018"
},
{
"ano": "2019"
},
{
"ano": "2020"
},
{
"ano": "2025"
},
{
"ano": "2030"
}
]
</pre>
<p>}
</p>
<!--
NewPP limit report
Preprocessor visited node count: 166/1000000
Preprocessor generated node count: 260/1000000
Post‐expand include size: 0/2097152 bytes
Template argument size: 0/2097152 bytes
Highest expansion depth: 2/40
Expensive parser function count: 0/100
-->
</div>]]>
|
