API-SEADE
Í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
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": { "codigo": "6", "nome": "Data de Aniversário do Município", "unidade": "Não possui unidade", "definicao": "Data em que o município comemora o seu aniversário; é determinada por lei municipal e não corresponde necessariamente à data de criação do município.", "nota": "Não possui nota", "fonte": [ "Instituto Geográfico e Cartográfico – IGC." ] } }