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

De SEADE
Ir para: navegação, pesquisa
(Criou página com '= 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 ...')
 
 
(28 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 12: Linha 12:
  
 
* '''Erro''': 404.
 
* '''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:'''
 +
<nowiki>http://api-ippi.seade.gov.br/v1/dados/X/Y/Z</nowiki>,
 +
'''onde X=localidade; Y=variável; Z=ano.'''.
 +
 +
= Recursos Disponíveis =
 +
 +
 +
== Dados ==
 +
'''GET'''
 +
 +
 +
* '''Path''': /dados
 +
* '''Parâmetros''': localidade/variável/ano
 +
 +
<nowiki>* É obrigatório a informação de no mínimo dois parâmetros.</nowiki>
 +
 +
<nowiki>* Coloque zero quando desejar trazer todos os dados de uma categoria.</nowiki>
 +
 +
=== 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"
 +
      ]
 +
    }
 +
}

Edição atual tal como às 13h48min 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"