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

De SEADE
Ir para: navegação, pesquisa
(Dados)
Linha 15: Linha 15:
  
 
= Recursos Disponíveis =
 
= 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>
 +
 +
=== Exemplo de chamada ===
 +
 +
curl -X GET "http://api-imp.seade.gov.br/dados/5/2/2010"
 +
 +
=== Retorno JSON ===
 +
 +
Exemplo:
 +
 +
{
 +
    "dados": [
 +
        {
 +
            "2010": "516.292",
 +
            "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",
 +
            "unidade": "(Em reais de 2011)"
 +
        }
 +
    ]
 +
}
  
  
Linha 82: Linha 114:
 
         "nota": "A partir de agosto de 2008, os dados referentes à área dos municípios paulistas ..."
 
         "nota": "A partir de agosto de 2008, os dados referentes à área dos municípios paulistas ..."
 
     }
 
     }
}
 
 
== Dados ==
 
'''GET'''
 
 
 
* '''Path''': /dados
 
* '''Parâmetros''': localidade/variável/ano
 
 
<nowiki>* É obrigatório a informação de no mínimo dois parâmetros.</nowiki>
 
 
=== Exemplo de chamada ===
 
 
curl -X GET "http://api-imp.seade.gov.br/dados/5/2/2010"
 
 
=== Retorno JSON ===
 
 
Exemplo:
 
 
{
 
    "dados": [
 
        {
 
            "2010": "516.292",
 
            "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",
 
            "unidade": "(Em reais de 2011)"
 
        }
 
    ]
 
 
  }
 
  }

Edição das 17h46min de 4 de outubro de 2013

Índice

Objetivo

Expor dados estatísticos governamentais do estado de São Paulo.

URI

http://api-imp.seade.gov.br

Código HTTP de Retorno

  • Sucesso: 200.
  • Erro: 404.


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.

Exemplo de chamada

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

Retorno JSON

Exemplo:

{
   "dados": [
       {
           "2010": "516.292",
           "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",
           "unidade": "(Em reais de 2011)"
       }
   ]
}


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/localidade"

ou

curl -X GET "http://api-imp.seade.gov.br/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"
   }
}

Variável

GET


  • Path: /variavel
  • 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/variavel"

ou

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


Retorno JSON

Exemplo:

{
   "variavel": {
       "codigo": "5",
       "nome": "Área",
       "unidade": "(Em km2)",
       "fonte": "Instituto Brasileiro de Geografia e Estatística–IBGE.",
       "nota": "A partir de agosto de 2008, os dados referentes à área dos municípios paulistas ..."
   }
}