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

De SEADE
Ir para: navegação, pesquisa
(→‎Sintaxe de chamada)
 
(21 edições intermediárias de um usuário não apresentadas)
Linha 5: Linha 5:
 
== URI ==
 
== URI ==
  
−
  http://api-tce.seade.gov.br/v1
+
  http://api-ippi.seade.gov.br/v1
  
 
== Código HTTP de Retorno ==
 
== Código HTTP de Retorno ==
Linha 13: Linha 13:
 
* '''Erro''': 404.
 
* '''Erro''': 404.
  
−
= Como recuperar dados do sistema IMP através da API =
+
= Como recuperar dados 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 19: Linha 19:
  
 
'''Sintaxe de chamada:'''  
 
'''Sintaxe de chamada:'''  
−
<nowiki>http://api-tce.seade.gov.br/v1/dados/X/Y/Z</nowiki>,  
+
<nowiki>http://api-ippi.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.'''.
  
Linha 38: Linha 38:
 
=== Sintaxe de chamada ===
 
=== Sintaxe de chamada ===
  
−
  curl -X GET "http://api-tce.seade.gov.br/v1/dados/5/2/2010"
+
  curl -X GET "http://api-ippi.seade.gov.br/v1/dados/503/5380/2013"
  
 
ou
 
ou
  
−
  curl -X GET "http://api-tce.seade.gov.br/v1/dados/0/2/2010"
+
  curl -X GET "http://api-ippi.seade.gov.br/v1/dados/0/5380/2013"
  
 
=== Retorno JSON ===
 
=== Retorno JSON ===
Linha 49: Linha 49:
  
 
  {
 
  {
−
     "dados": [
+
     dados: [
 
         {
 
         {
−
             "codigo_localidade": "5",
+
             codigo_localidade: "503",
−
             "localidade": "Águas de Lindóia",
+
             localidade: "São Paulo",
−
             "nome_localidade_pai": "Região de Governo de Bragança Paulista",
+
            codigo_pai: "681",
−
             "codigo_variavel": "2",
+
             nome_localidade_pai: "RM - São Paulo",
−
             "variavel": "Crédito Rural Agricultura",
+
             codigo_variavel: "5380",
−
             "periodo:" "1985/1989-2010",
+
             variavel: "Taxa média de mortalidade por causas evitáveis em menores de um ano",
−
             "unidade": "(Em reais de 2011)",
+
             periodo: "2013",
−
             "ano": {
+
            ultimo_ano: "2013",
−
                "2010": "516.292"
+
             unidade: "(Por mil nascidos vivos)",
 +
             d_2013: "8,39"
 
             }
 
             }
 
         }
 
         }
Linha 73: Linha 74:
 
* '''Parâmetros''': código
 
* '''Parâmetros''': código
  
−
Caso o código não seja passado, a busca trará todas as fontes.
+
É necessário informar o "código" ou a palavra "all" para listar todos os registros.
  
  
 
=== Sintaxe de chamada ===
 
=== Sintaxe de chamada ===
  
−
  curl -X GET "http://api-tce.seade.gov.br/v1/fonte"
+
  curl -X GET "http://api-ippi.seade.gov.br/v1/fonte/all"
  
 
ou
 
ou
  
−
  curl -X GET "http://api-tce.seade.gov.br/v1/fonte/{codigo}"
+
  curl -X GET "http://api-ippi.seade.gov.br/v1/fonte/{codigo}"
  
 
=== Retorno JSON ===
 
=== Retorno JSON ===
Linha 89: Linha 90:
  
 
  {
 
  {
−
     "fonte": {
+
     fontes: [
−
        "codigo": "10",
+
      {
−
        "nome": "Companhia Energética de São Paulo  – CESP."
+
      codigo: "992",
−
    }
+
      nome: "Fundação Seade. Índice Paulista de Responsabilidade Social – IPRS."
 +
      }
 +
  ]
 
  }
 
  }
−
 
  
 
== Localidade ==
 
== Localidade ==
Linha 104: Linha 106:
 
* '''Parâmetros''': código
 
* '''Parâmetros''': código
  
−
Caso o código não seja passado, a busca trará todas as localidades.
+
É necessário informar o "código" ou a palavra "all" para listar todos os registros.
  
  
 
=== Sintaxe de chamada ===
 
=== Sintaxe de chamada ===
  
−
  curl -X GET "http://api-tce.seade.gov.br/v1/localidade"
+
  curl -X GET "http://api-ippi.seade.gov.br/v1/localidade/all"
  
 
ou
 
ou
  
−
  curl -X GET "http://api-tce.seade.gov.br/v1/localidade/{codigo}"
+
  curl -X GET "http://api-ippi.seade.gov.br/v1/localidade/{codigo}"
  
 
=== Retorno JSON ===
 
=== Retorno JSON ===
Linha 120: Linha 122:
  
 
  {
 
  {
−
     "localidade": {
+
     localidade: {
−
         "codigo": "10",
+
         codigo: "10",
−
         "nome": "Altinópolis",
+
         nome: "Altinópolis",
−
         "nivel": "Altinópolis",
+
         nivel: "Altinópolis",
−
         "codigo_pai": "731",
+
         codigo_pai: "731",
−
         "nome_pai": "Região de Governo de Ribeirão Preto"
+
         nome_pai: "Região de Governo de Ribeirão Preto"
 
     }
 
     }
 
  }
 
  }
−
 
  
 
== Nota ==
 
== Nota ==
Linha 138: Linha 139:
 
* '''Parâmetros''': código
 
* '''Parâmetros''': código
  
−
Caso o código não seja passado, a busca trará todas as notas cadastradas.
+
É necessário informar o "código" ou a palavra "all" para listar todos os registros.
  
  
 
=== Sintaxe de chamada ===
 
=== Sintaxe de chamada ===
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/nota"
+
  curl -X GET "http://api-ippi.seade.gov.br/v1/nota/all"
  
 
ou
 
ou
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/nota/{codigo}"
+
  curl -X GET "http://api-ippi.seade.gov.br/v1/nota/{codigo}"
−
 
+
  
 
=== Retorno JSON ===
 
=== Retorno JSON ===
Linha 155: Linha 155:
  
 
  {
 
  {
−
    "nota": {
+
  notas: [
−
        "codigo": "100",
+
    {
−
        "descricao": "No modelo de projeção utilizado, ou seja para os anos de 1997 e 1998, foi considerado um ajuste na ..."
+
      codigo: "304",
−
    }
+
      descricao: "As estimativas de população referem-se a 1º de julho de cada ano."
 +
    }
 +
  ]
 
  }
 
  }
  
Linha 169: Linha 171:
 
* '''Parâmetros''': código
 
* '''Parâmetros''': código
  
−
Para buscar todas as variáveis, é necessário informar os parâmetros de paginação, conforme a sintaxe abaixo.
+
É necessário informar o "código" ou a palavra "all" para listar todos os registros.
−
 
+
−
* '''Path''': /variavel?offset={inicial}&limit={limite}
+
  
  
 
=== Sintaxe de chamada ===
 
=== Sintaxe de chamada ===
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/variavel/{codigo}"
+
  curl -X GET "http://api-ippi.seade.gov.br/v1/variavel/all"
  
 
ou
 
ou
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/variavel?offset=0&limit=10"
+
  curl -X GET "http://api-ippi.seade.gov.br/v1/variavel/{codigo}"
−
 
+
  
 
=== Retorno JSON ===
 
=== Retorno JSON ===
  
 
Exemplo:
 
Exemplo:
−
 
  
 
  {
 
  {
−
   "variavel": {
+
   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>."
+
−
      ]
+
−
  }
+
−
}
+
−
 
+
−
 
+
−
 
+
−
 
+
−
== 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",
+
      codigo: "5380",
−
      "localidade": "São Paulo",
+
      nome: "Taxa média de mortalidade por causas evitáveis em menores de um ano",
−
      "loc_pai": "Região Metropolitana de São Paulo",
+
      unidade: "(Por mil nascidos vivos)",
−
      "loc_pai2": "Total do Estado de São Paulo",
+
      periodo: "2013",
−
      "prefeito": "Fernando Haddad - PT",
+
      ultino_ano: "2013",
−
      "presidente_camara": "Antonio Donato Madormo - PT ",
+
      definicao: "Relação entre os óbitos de menores de um ano por causa evitáveis, residentes numa unidade geográfica, num determinado período de tempo, e os nascidos vivos da mesma unidade nesse período.
−
      "aniversario": "25 de janeiro",
+
              Foi considerado o período de sete anos, para os municípios com menos de 10 mil habitantes, e de três anos, para os demais. ",
−
      "link_historico": "http://www.seade.gov.br/produtos/perfil/hist/hist_503.pdf",
+
      fonte: [
−
      "santo_padroeiro": "Nossa Senhora da Penha de Franca"
+
          "Fundação Seade."
 +
      ],
 +
      nota: [
 +
        "Componente do IPPI"
 +
      ]
 
     }
 
     }
−
  ]
+
  }
−
}
+
−
 
+
−
 
+
−
== 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 14h48min de 24 de julho de 2017

Í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. 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-ippi.seade.gov.br/v1

Código HTTP de Retorno

  • Sucesso: 200.
  • Erro: 404.

Como recuperar dados 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-ippi.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-ippi.seade.gov.br/v1/dados/503/5380/2013"

ou 

curl -X GET "http://api-ippi.seade.gov.br/v1/dados/0/5380/2013"

Retorno JSON

Exemplo: 

{
   dados: [
       {
           codigo_localidade: "503",
           localidade: "São Paulo",
           codigo_pai: "681",
           nome_localidade_pai: "RM - São Paulo",
           codigo_variavel: "5380",
           variavel: "Taxa média de mortalidade por causas evitáveis em menores de um ano",
           periodo: "2013",
           ultimo_ano: "2013",
           unidade: "(Por mil nascidos vivos)",
           d_2013: "8,39"
           }
       }
   ]
}

Fonte

GET


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

É necessário informar o "código" ou a palavra "all" para listar todos os registros.


Sintaxe de chamada 

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

ou 

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

Retorno JSON

Exemplo: 

{
   fontes: [
     {
      codigo: "992",
      nome: "Fundação Seade. Índice Paulista de Responsabilidade Social – IPRS."
     }
  ]
}

Localidade

GET


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

É necessário informar o "código" ou a palavra "all" para listar todos os registros.


Sintaxe de chamada 

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

ou 

curl -X GET "http://api-ippi.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

É necessário informar o "código" ou a palavra "all" para listar todos os registros.


Sintaxe de chamada 

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

ou 

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

Retorno JSON

Exemplo: 

{
  notas: [
    {
      codigo: "304",
      descricao: "As estimativas de população referem-se a 1º de julho de cada ano."
    }
 ]
}

Variável

GET

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

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

É necessário informar o "código" ou a palavra "all" para listar todos os registros.


Sintaxe de chamada 

curl -X GET "http://api-ippi.seade.gov.br/v1/variavel/all"

ou 

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

Retorno JSON

Exemplo: 

{
  variavel: {
   {
      codigo: "5380",
      nome: "Taxa média de mortalidade por causas evitáveis em menores de um ano",
      unidade: "(Por mil nascidos vivos)",
      periodo: "2013",
      ultino_ano: "2013",
      definicao: "Relação entre os óbitos de menores de um ano por causa evitáveis, residentes numa unidade geográfica, num determinado período de tempo, e os nascidos vivos da mesma unidade nesse período. 
             Foi considerado o período de sete anos, para os municípios com menos de 10 mil habitantes, e de três anos, para os demais. ",
      fonte: [
         "Fundação Seade."
      ],
      nota: [
        "Componente do IPPI"
      ]
   }
}
Disponível em "http://doc.seade.gov.br/index.php?title=API-IPPI&oldid=290"