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

De SEADE
Ir para: navegação, pesquisa
(→‎Como recuperar dados do sistema IMP)
(→‎Retorno JSON)
 
(20 edições intermediárias de 2 usuários não apresentadas)
Linha 3: Linha 3:
 
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 dos 645 municípios paulistas, em outros sítios ou a reutilização em sistemas desenvolvidos por usuários, mediante acesso direto à base de informações, sempre atualizada, do IMP – Informações dos Municípios Paulistas. O formato, em código aberto, é o JSON e não há necessidade de cadastro ou qualquer outro procedimento para o acesso.
 
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 dos 645 municípios paulistas, em outros sítios ou a reutilização em sistemas desenvolvidos por usuários, mediante acesso direto à base de informações, sempre atualizada, do IMP – Informações dos Municípios Paulistas. O formato, em código aberto, é o JSON e não há necessidade de cadastro ou qualquer outro procedimento para o acesso.
  
−
=== URI ===
+
== URI ==
  
 
  http://api-imp.seade.gov.br/v1
 
  http://api-imp.seade.gov.br/v1
  
−
=== Código HTTP de Retorno ===
+
== Código HTTP de Retorno ==
  
 
* '''Sucesso''': 200.
 
* '''Sucesso''': 200.
Linha 14: Linha 14:
  
  
−
== Como recuperar dados do sistema IMP ==
+
= Como recuperar dados do sistema IMP 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: localidade; variável; ano.  
 
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: localidade; variável; ano.  
Linha 21: Linha 21:
 
'''Sintaxe de chamada:'''  
 
'''Sintaxe de chamada:'''  
 
<nowiki>http://api-imp.seade.gov.br/v1/dados/X/Y/Z</nowiki>,  
 
<nowiki>http://api-imp.seade.gov.br/v1/dados/X/Y/Z</nowiki>,  
−
'''onde X=localidade; Y=variável; Z=ano.'''
+
'''onde X=localidade; Y=variável; Z=ano.'''.
  
 
= Recursos Disponíveis =
 
= Recursos Disponíveis =
−
 
  
  
Linha 192: Linha 191:
 
Exemplo:
 
Exemplo:
  
−
 
+
{
−
{
+
  "variavel": {
−
  "variavel": {
+
    "55": {
 
       "codigo": "55",
 
       "codigo": "55",
 
       "nome": "População",
 
       "nome": "População",
 
       "unidade": "Não possui unidade",
 
       "unidade": "Não possui unidade",
−
       "periodo": "1980-2013",
+
       "periodo": "1980-2018",
 
       "definicao": "Não possui definicao",
 
       "definicao": "Não possui definicao",
 
       "fonte": [
 
       "fonte": [
−
        "Instituto Brasileiro de Geografia e Estatística – IBGE.",
+
        "Fundação Seade.",
−
        "Fundação Seade."
+
        "Instituto Brasileiro de Geografia e Estatística – IBGE."
 
       ],
 
       ],
 
       "nota": [
 
       "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:
 
         "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;        
+
            - até 1982, 571 municípios;
−
          - de 1983 a 1992, 572 municípios;
+
            - de 1983 a 1992, 572 municípios;
−
          - de 1993 a 1996, 625 municípios;
+
            - de 1993 a 1996, 625 municípios;
−
          - a partir 1997, 645 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,  
 
         "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  
+
         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  
+
         componentes. A população de base, por idade e sexo, considera os resultados correspondentes aos diversos Censos Demográficos  
−
        populações projetadas referem-se a 1º de julho de cada ano. Para maiores informações, ver  
+
        realizados pelo IBGE. As populações projetadas referem-se a 1º de julho de cada ano.
−
         <a href="http://www.seade.gov.br/produtos/projpop/pdfs/projpop_metodologia.pdf" target="_blank">Metodologia</a>."
+
        Para maiores informações, ver  
 +
         <a href=\"http://www.imp.seade.gov.br/wordpress/wp-content/uploads/2016/07/projpop_metodologia.pdf\" target=\"_blank\">Metodologia</a>."
 
       ]
 
       ]
−
  }
+
    }
 +
  }
 +
}
 +
 
 +
== Perfil Municipal - informações do município ==
 +
'''GET'''
 +
 
 +
Use o formato abaixo para buscar uma variável por requisição.
 +
 
 +
* '''Path''': /infmun
 +
* '''Parâmetros''': código
 +
 
 +
Para buscar todas as variáveis, é necessário informar os parâmetros de paginação, conforme a sintaxe abaixo.
 +
 
 +
* '''Path''': /infmun/{codigo}
 +
 
 +
 
 +
=== Sintaxe de chamada ===
 +
 
 +
curl -X GET "http://api-imp.seade.gov.br/v1/infmun/{codigo}"
 +
 
 +
ou
 +
 
 +
curl -X GET "http://api-imp.seade.gov.br/v1/infmun/{codigo}"
 +
 
 +
 
 +
=== Retorno JSON ===
 +
 
 +
Exemplo:
 +
 
 +
 
 +
{
 +
  "infmun": [
 +
    {
 +
      "codigo_localidade": "503",
 +
      "localidade": "São Paulo",
 +
      "loc_pai": "Região Metropolitana de São Paulo",
 +
      "loc_pai2": "Total do Estado de São Paulo",
 +
      "aniversario": "25 de janeiro",
 +
      "link_historico": "http://www.seade.gov.br/produtos/perfil/hist/hist_503.pdf",
 +
      "santo_padroeiro": "Nossa Senhora da Penha de Franca"
 +
    }
 +
  ]
 
}
 
}
 +
 +
== Perfil Municipal - dados ==
 +
'''GET'''
 +
 +
Use o formato abaixo para buscar uma variável por requisição.
 +
 +
* '''Path''': /perfil
 +
* '''Parâmetros''': código
 +
 +
Para buscar todas as variáveis, é necessário informar os parâmetros de paginação, conforme a sintaxe abaixo.
 +
 +
* '''Path''': /perfil/{codigo}
 +
 +
 +
=== Sintaxe de chamada ===
 +
 +
curl -X GET "http://api-imp.seade.gov.br/v1/perfil/{codigo}"
 +
 +
ou
 +
 +
curl -X GET "http://api-imp.seade.gov.br/v1/perfil/{codigo}"
 +
 +
 +
=== Retorno JSON ===
 +
 +
Exemplo:
 +
 +
 +
{
 +
  "perfil": [
 +
    {
 +
      "codigo_localidade": "503",
 +
      "localidade": "São Paulo",
 +
      "codigo_localidade_pai": "681",
 +
      "nome_localidade_pai": "Região Metropolitana de São Paulo",
 +
      "codigo_variavel": "1",
 +
      "variavel": "Crédito Rural",
 +
      "unidade": "(Em reais de 2015)",
 +
      "periodo": "1985/1989-2011",
 +
      "ano": {
 +
        "2011": "2.339.704.690"
 +
      }
 +
    },
 +
    {
 +
      "codigo_localidade": "503",
 +
      "localidade": "São Paulo",
 +
      "codigo_localidade_pai": "681",
 +
      "nome_localidade_pai": "Região Metropolitana de São Paulo",
 +
      "codigo_variavel": "2",
 +
      "variavel": "Crédito Rural Agricultura",
 +
      "unidade": "(Em reais de 2015)",
 +
      "periodo": "1985/1989-2011",
 +
      "ano": {
 +
        "2011": "1.605.918.449"
 +
      }
 +
    },
 +
    {
 +
      "codigo_localidade": "503",
 +
      "localidade": "São Paulo",
 +
      "codigo_localidade_pai": "681",
 +
      "nome_localidade_pai": "Região Metropolitana de São Paulo",
 +
      "codigo_variavel": "3",
 +
      "variavel": "Crédito Rural Pecuária",
 +
      "unidade": "(Em reais de 2015)",
 +
      "periodo": "1985/1989-2011",
 +
      "ano": {
 +
        "2011": "733.786.243"
 +
      }
 +
    },
 +
...

Edição atual tal como às 16h52min de 17 de maio de 2018

Í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 dos 645 municípios paulistas, em outros sítios ou a reutilização em sistemas desenvolvidos por usuários, mediante acesso direto à base de informações, sempre atualizada, do IMP – Informações dos Municípios Paulistas. 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-imp.seade.gov.br/v1

Código HTTP de Retorno

  • Sucesso: 200.
  • Erro: 404.


Como recuperar dados do sistema IMP 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: localidade; variável; ano. Caso a intenção seja recuperar todos os registros (dados) de uma dimensão / parâmetro, deve ser utilizado o 0 (zero) na sintaxe de comando. Ressalta-se que é indispensável a indicação de, ao menos, duas dimensões / parâmetros.

Sintaxe de chamada: http://api-imp.seade.gov.br/v1/dados/X/Y/Z, onde X=localidade; Y=variável; Z=ano..

Recursos Disponíveis

Dados

GET


  • Path: /dados
  • Parâmetros: localidade/variável/ano

* É obrigatório a informação de no mínimo dois parâmetros.

* Coloque zero quando desejar trazer todos os dados de uma categoria.

Sintaxe de chamada 

curl -X GET "http://api-imp.seade.gov.br/v1/dados/5/2/2010"

ou 

curl -X GET "http://api-imp.seade.gov.br/v1/dados/0/2/2010"


Retorno JSON

Exemplo: 

{
   "dados": [
       {
           "codigo_localidade": "5",
           "localidade": "Águas de Lindóia",
           "nome_localidade_pai": "Região de Governo de Bragança Paulista",
           "codigo_variavel": "2",
           "variavel": "Crédito Rural Agricultura",
           "periodo:" "1985/1989-2010",
           "unidade": "(Em reais de 2011)",
           "ano": {
               "2010": "516.292"
           }
       }
   ]
}

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": {
   "55": {
     "codigo": "55",
     "nome": "População",
     "unidade": "Não possui unidade",
     "periodo": "1980-2018",
     "definicao": "Não possui definicao",
     "fonte": [
       "Fundação Seade.",
       "Instituto Brasileiro de Geografia e Estatística – IBGE."
     ],
     "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.imp.seade.gov.br/wordpress/wp-content/uploads/2016/07/projpop_metodologia.pdf\" target=\"_blank\">Metodologia</a>."
     ]
   }
 }
}

Perfil Municipal - informações do município

GET

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

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

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

  • Path: /infmun/{codigo}


Sintaxe de chamada 

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

ou 

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


Retorno JSON

Exemplo:


{ 

 "infmun": [
   {
     "codigo_localidade": "503",
     "localidade": "São Paulo",
     "loc_pai": "Região Metropolitana de São Paulo",
     "loc_pai2": "Total do Estado de São Paulo",
     "aniversario": "25 de janeiro",
     "link_historico": "http://www.seade.gov.br/produtos/perfil/hist/hist_503.pdf",
     "santo_padroeiro": "Nossa Senhora da Penha de Franca"
   }
 ]

}

Perfil Municipal - dados

GET

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

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

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

  • Path: /perfil/{codigo}


Sintaxe de chamada 

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

ou 

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


Retorno JSON

Exemplo:


{ 

 "perfil": [
   {
     "codigo_localidade": "503",
     "localidade": "São Paulo",
     "codigo_localidade_pai": "681",
     "nome_localidade_pai": "Região Metropolitana de São Paulo",
     "codigo_variavel": "1",
     "variavel": "Crédito Rural",
     "unidade": "(Em reais de 2015)",
     "periodo": "1985/1989-2011",
     "ano": {
       "2011": "2.339.704.690"
     }
   },
   {
     "codigo_localidade": "503",
     "localidade": "São Paulo",
     "codigo_localidade_pai": "681",
     "nome_localidade_pai": "Região Metropolitana de São Paulo",
     "codigo_variavel": "2",
     "variavel": "Crédito Rural Agricultura",
     "unidade": "(Em reais de 2015)",
     "periodo": "1985/1989-2011",
     "ano": {
       "2011": "1.605.918.449"
     }
   },
   {
     "codigo_localidade": "503",
     "localidade": "São Paulo",
     "codigo_localidade_pai": "681",
     "nome_localidade_pai": "Região Metropolitana de São Paulo",
     "codigo_variavel": "3",
     "variavel": "Crédito Rural Pecuária",
     "unidade": "(Em reais de 2015)",
     "periodo": "1985/1989-2011",
     "ano": {
       "2011": "733.786.243"
     }
   },

...

Disponível em "http://doc.seade.gov.br/index.php?title=API-SEADE&oldid=352"