API-PERFIL
= 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 serviços públicos em outros sítios, ou a reutilização em sistemas desenvolvidos por usuários, mediante acesso direto à base de informações sempre atualizadas do Perfil Municipal do Estado de São Paulo. O formato, em código aberto, é o JSON e não há necessidade de cadastro ou qualquer outro procedimento para o acesso.
Índice |
URI
http://api-perfil.seade.gov.br/v1
Código HTTP de Retorno
- Sucesso: 200.
- Erro: 404.
Recursos Disponíveis
Dados
Dados referentes aos temas
GET
- Path: /dados/tema
- Parâmetros: localidade/tema
* tema = all (lista os dados de todos os temas.
* tema = código do tema (lista os dados do tema indicado.)
Sintaxe de chamada
curl -X GET "http://api-perfil.seade.gov.br/v1/dados/tema/503/all"
ou
curl -X GET "http://api-perfil.seade.gov.br/v1/dados/tema/503/{tema}"
Retorno JSON
Exemplo:
{ infolocalidade: { nivel: "70", mapa: 1, codigo: "503", nome: "São Paulo", pai: "Região Metropolitana de São Paulo", pai_do_pai: "Total do Estado de São Paulo", historico: "hist_503.pdf", prefeito: "João Agripino da Costa Doria Junior - PSDB", presidente_camara: "Milton Leite da Silva - DEM", aniversario: "25 de janeiro", santo_padroeiro: "Nossa Senhora da Penha de Franca" }, tema: [ { codigo: "1", nome: "Território e População", dados: [ { codigo: "5", grafico: 0, nome: "Área", unidade: "(Em km2)", ano: "2017", mun: "1.521,11", rm: "7.946,96", est: "248.222,36" }, { codigo: "55", grafico: 0, nome: "População", unidade: null, ano: "2017", mun: "11.696.088", rm: "20.717.505", est: "43.674.533" }, .... ] } ] }
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-perfil.seade.gov.br/v1/fonte/all"
ou
curl -X GET "http://api-perfil.seade.gov.br/v1/fonte/{codigo}"
Retorno JSON
Exemplo:
{ fontes: [ { codigo: "1", nome: "Banco Central do Brasil – Bacen." }, { codigo: "3", nome: "Instituto Brasileiro de Geografia e Estatística – IBGE." }, { codigo: "4", nome: "Instituto Geográfico e Cartográfico – IGC." }, { codigo: "5", nome: "Telecomunicações Brasileiras S.A. – Telebras." }, ... ] }
Localidade
GET
- Path: /localidade
Trará todas as localidades com código, descrição e nível.
Sintaxe de chamada
curl -X GET "http://api-perfil.seade.gov.br/v1/localidade"
Retorno JSON
Exemplo:
{ localidades: [ { cod_nivel: "0", desc_nivel: "Estado de São Paulo", locais: [ { cod: "1000", nome: "Total do Estado de São Paulo" } ] }, { cod_nivel: "10", desc_nivel: "Região Administrativa", locais: [ { cod: "693", nome: "Região Administrativa Central" }, { cod: "690", nome: "Região Administrativa de Araçatuba" }, ... }, ... ] }
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-perfil.seade.gov.br/v1/nota/all"
ou
curl -X GET "http://api-perfil.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/perfil
- Parâmetros: código
Sintaxe de chamada
curl -X GET "http://api-perfil.seade.gov.br/v1/variavel/perfil/all"
ou
curl -X GET ""http://api-perfil.seade.gov.br/v1/variavel/perfil/{codigo}"
Retorno JSON
Exemplo:
{ "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>." ] } }
Tema
GET
Use o formato abaixo para buscar uma variável por requisição.
- Path: /tema
- Parâmetros: código
Sintaxe de chamada
curl -X GET "http://api-perfil.seade.gov.br/v1/tema/all"
ou
curl -X GET "http://api-perfil.seade.gov.br/v1/tema/{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", "prefeito": "Fernando Haddad - PT", "presidente_camara": "Antonio Donato Madormo - PT ", "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-perfil.seade.gov.br/v1/perfil/{codigo}"
ou
curl -X GET "http://api-perfil.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" } },
...