Mudanças entre as edições de "API-PROJPOP"

De SEADE
Ir para: navegação, pesquisa
(→‎Sintaxe de chamada 'IE'(Idade Escolar):)
(→‎Sintaxe de chamada 'ESP'(Total Estado de SP))
Linha 175: Linha 175:
 
<nowiki>* Coloque all no parâmetro ano quando quiser trazer todos os anos.</nowiki>
 
<nowiki>* Coloque all no parâmetro ano quando quiser trazer todos os anos.</nowiki>
  
−
=== Sintaxe de chamada ===
+
=== Sintaxe de chamada 'ESP'(Total Estado de SP) ===
  
 
  curl -X GET "http://api-projpop.seade.gov.br/v1/dados/iq/esp/t/0/2016"
 
  curl -X GET "http://api-projpop.seade.gov.br/v1/dados/iq/esp/t/0/2016"
Linha 182: Linha 182:
  
 
  curl -X GET "http://api-projpop.seade.gov.br/v1/dados/iq/esp/t/0/all"
 
  curl -X GET "http://api-projpop.seade.gov.br/v1/dados/iq/esp/t/0/all"
−
 
  
 
=== Retorno JSON ===
 
=== Retorno JSON ===

Edição das 16h26min de 10 de junho de 2016

Índice

Apresentação

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.

URI 

http://api-projpop.seade.gov.br/v1

Código HTTP de Retorno

  • Sucesso: 200.
  • Erro: 404.

Como recuperar dados do sistema PROJPOP através da API

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.

Sintaxe de chamada caso faixa-etaria seja igual a 'IQ'(Idade Quinquenal) ou 'SF'(Sem faixa etária):
http://api-projpop.seade.gov.br/v1/dados/A/B/C/D/E
onde A=faixa-etaria; B=localidade; C=sexo; D=cod_localidade; E=ano..


Sintaxe de chamada caso faixa-etaria seja igual a 'IE'(Idade Escolar):
http://api-projpop.seade.gov.br/v1/dados/A/B/C/D/E
onde A=faixa-etaria; B=localidade; C=cod_localidade; D=ano..


OBS: Caso o parâmetro B=localidade seja 'ESP'(Total Estado de SP), o parâmetro cod_localidade deve ser igual a 0, para se retornar todas as localidades das regiões, municípios, ras etc. Do estado de São Paulo.

Recursos Disponíveis

Dados

GET Caso parâmetro faixa-etaria igual a 'IQ'(Idade Quinquenal) ou 'SF'(Sem Faixa):

  • Path: /dados
  • Parâmetros: faixa-etaria/localidade/sexo/cod-localidade/ano

* É obrigatório a informação todos os parâmetros.

* Coloque all no parâmetro ano quando quiser trazer todos os anos.

Sintaxe de chamada 'IQ'(Idade Quinquenal) ou 'SF'(Sem Faixa) 

curl -X GET "http://api-projpop.seade.gov.br/v1/dados/iq/dc/t/80008/2016"

ou 

curl -X GET "http://api-projpop.seade.gov.br/v1/dados/iq/dc/t/80008/all"

Retorno JSON

Exemplo: 

{

   "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"
       }
   ]

}



Caso parâmetro faixa-etaria igual a 'IE'(Idade Escolar):

  • Path: /dados
  • Parâmetros: faixa-etaria/localidade/cod-localidade/ano

* É obrigatório a informação todos os parâmetros.

* Coloque all no parâmetro ano quando quiser trazer todos os anos.

Sintaxe de chamada 'IE'(Idade Escolar) 

curl -X GET "http://api-projpop.seade.gov.br/v1/dados/ie/dc/80008/2016"

ou 

curl -X GET "http://api-projpop.seade.gov.br/v1/dados/ie/dc/80008/all"

Retorno JSON

Exemplo: { 

   "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"
       }
   ]

}




Caso parâmetro localidade igual a 'ESP'(Total Estado de SP):

  • Path: /dados
  • Parâmetros: faixa-etaria/localidade/cod-localidade/sexo/ano

* É obrigatório a informação todos os parâmetros.

* Coloque all no parâmetro ano quando quiser trazer todos os anos.

Sintaxe de chamada 'ESP'(Total Estado de SP) 

curl -X GET "http://api-projpop.seade.gov.br/v1/dados/iq/esp/t/0/2016"

ou 

curl -X GET "http://api-projpop.seade.gov.br/v1/dados/iq/esp/t/0/all"

Retorno JSON

{ 

   "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"
       }
   ]

}

Fonte

GET


  • Path: /fonte
  • Parâmetros: código

Caso o código não seja passado, a busca trará todas as fontes.


Sintaxe de chamada 

curl -X GET "http://api-imp.seade.gov.br/v1/fonte"

ou 

curl -X GET "http://api-imp.seade.gov.br/v1/fonte/{codigo}"


Retorno JSON

Exemplo: 

{
   "fonte": {
       "codigo": "10",
       "nome": "Companhia Energética de São Paulo  –  CESP."
   }
}


Localidade

GET


  • Path: /localidade
  • Parâmetros: código

Caso o código não seja passado, a busca trará todas as localidades.


Sintaxe de chamada 

curl -X GET "http://api-imp.seade.gov.br/v1/localidade"

ou 

curl -X GET "http://api-imp.seade.gov.br/v1/localidade/{codigo}"


Retorno JSON

Exemplo: 

{
   "localidade": {
       "codigo": "10",
       "nome": "Altinópolis",
       "nivel": "Altinópolis",
       "codigo_pai": "731",
       "nome_pai": "Região de Governo de Ribeirão Preto"
   }
}


Nota

GET


  • Path: /nota
  • Parâmetros: código

Caso o código não seja passado, a busca trará todas as notas cadastradas.


Sintaxe de chamada 

curl -X GET "http://api-imp.seade.gov.br/v1/nota"

ou 

curl -X GET "http://api-imp.seade.gov.br/v1/nota/{codigo}"


Retorno JSON

Exemplo: 

{
   "nota": {
       "codigo": "100",
       "descricao": "No modelo de projeção utilizado, ou seja para os anos de 1997 e 1998, foi considerado um ajuste na ..."
   }
}

Variável

GET

Use o formato abaixo para buscar uma variável por requisição.

  • Path: /variavel
  • Parâmetros: código

Para buscar todas as variáveis, é necessário informar os parâmetros de paginação, conforme a sintaxe abaixo.

  • Path: /variavel?offset={inicial}&limit={limite}


Sintaxe de chamada 

curl -X GET "http://api-imp.seade.gov.br/v1/variavel/{codigo}"

ou 

curl -X GET "http://api-imp.seade.gov.br/v1/variavel?offset=0&limit=10"


Retorno JSON

Exemplo: 


{
  "variavel": {
     "codigo": "55",
     "nome": "População",
     "unidade": "Não possui unidade",
     "periodo": "1980-2013",
     "definicao": "Não possui definicao",
     "fonte": [
        "Instituto Brasileiro de Geografia e Estatística – IBGE.",
        "Fundação Seade."
     ],
     "nota": [
       "Os dados referem-se aos municípios de acordo com a divisão administrativa do Estado de São Paulo vigente no respectivo período:
         - até 1982, 571 municípios;          
         - de 1983 a 1992, 572 municípios;
         - de 1993 a 1996, 625 municípios;
         - a partir 1997, 645 municípios.",
       "As populações aqui apresentadas resultam de projeções elaboradas pelo método dos componentes demográficos. Este método considera as tendências de fecundidade, 
        mortalidade e migração, a partir das estatísticas vitais processadas na Fundação Seade, e a formulação de hipóteses de comportamento futuro para estes 
        componentes. A população de base, por idade e sexo, considera os resultados correspondentes aos diversos Censos Demográficos realizados pelo IBGE. As 
        populações projetadas referem-se a 1º de julho de cada ano. Para maiores informações, ver 
        <a href="http://www.seade.gov.br/produtos/projpop/pdfs/projpop_metodologia.pdf" target="_blank">Metodologia</a>."
     ]
  }
}
Disponível em "http://doc.seade.gov.br/index.php?title=API-PROJPOP&oldid=181"