Mudanças entre as edições de "API-PERFIL"
(→Retorno JSON) |
|||
(19 edições intermediárias de um usuário não apresentadas) | |||
Linha 1: | Linha 1: | ||
− | = 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. | + | = 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. | ||
== URI == | == URI == | ||
Linha 13: | Linha 15: | ||
= Recursos Disponíveis = | = Recursos Disponíveis = | ||
− | + | == Tema == | |
− | == | + | |
− | + | ||
− | + | ||
− | + | ||
'''GET''' | '''GET''' | ||
+ | * '''Path''': /tema | ||
+ | * '''Parâmetros''': código | ||
− | + | <nowiki>* codigo = all (lista todos os temas) </nowiki> | |
− | + | ||
− | + | ||
− | <nowiki>* | + | |
− | + | ||
− | + | ||
=== Sintaxe de chamada === | === Sintaxe de chamada === | ||
− | curl -X GET "http://api-perfil.seade.gov.br/v1 | + | curl -X GET "http://api-perfil.seade.gov.br/v1/tema/all" |
ou | ou | ||
− | curl -X GET "http://api-perfil.seade.gov.br/v1 | + | curl -X GET "http://api-perfil.seade.gov.br/v1/tema/{codigo}" |
+ | |||
=== Retorno JSON === | === Retorno JSON === | ||
Linha 40: | Linha 36: | ||
Exemplo: | Exemplo: | ||
− | + | { | |
− | + | fontes: [ | |
− | + | { | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
codigo: "1", | codigo: "1", | ||
− | nome: "Território e População" | + | nome: "Território e População" |
− | + | }, | |
− | + | { | |
− | + | codigo: "2", | |
− | + | nome: "Estatísticas Vitais e Saúde" | |
− | + | }, | |
− | + | { | |
− | + | codigo: "3", | |
− | + | nome: "Condições de Vida" | |
− | + | }, | |
− | + | .... | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
] | ] | ||
− | + | } | |
== Localidade == | == Localidade == | ||
Linha 177: | Linha 101: | ||
} | } | ||
− | == | + | == Dados == |
+ | |||
'''GET''' | '''GET''' | ||
+ | * '''Path''': /dados/tema | ||
+ | * '''Parâmetros''': localidade/codigo | ||
− | |||
− | * | + | <nowiki>* localidade = código da localidade </nowiki> |
− | + | <nowiki>* codigo = all (lista os dados de todos os temas da localidade ) </nowiki> | |
+ | |||
+ | <nowiki>* codigo = código do tema </nowiki> | ||
=== Sintaxe de chamada === | === Sintaxe de chamada === | ||
− | curl -X GET "http://api-perfil.seade.gov.br/v1/ | + | curl -X GET "http://api-perfil.seade.gov.br/v1/dados/tema/{localidade}/all" |
ou | ou | ||
− | curl -X GET "http://api-perfil.seade.gov.br/v1/ | + | curl -X GET "http://api-perfil.seade.gov.br/v1/dados/tema/{localidade}/{codigo}" |
=== Retorno JSON === | === Retorno JSON === | ||
Linha 201: | Linha 129: | ||
{ | { | ||
− | + | 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", | ||
+ | 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" | ||
+ | }, | ||
+ | .... | ||
+ | ] | ||
+ | } | ||
+ | ] | ||
} | } | ||
== Variável == | == Variável == | ||
− | |||
− | + | '''GET''' | |
* '''Path''': /variavel/perfil | * '''Path''': /variavel/perfil | ||
* '''Parâmetros''': código | * '''Parâmetros''': código | ||
+ | |||
+ | <nowiki>* codigo = all (lista todas as variáveis ) </nowiki> | ||
=== Sintaxe de chamada === | === Sintaxe de chamada === | ||
Linha 227: | Linha 192: | ||
Exemplo: | Exemplo: | ||
+ | { | ||
+ | variavel: { | ||
+ | 185: { | ||
+ | codigo: "185", | ||
+ | nome: "Taxa de Analfabetismo da População de 15 Anos e Mais - Censo Demográfico", | ||
+ | unidade: "(Em %)", | ||
+ | periodo: "1991/2000/2010", | ||
+ | ultimo_ano: "2010", | ||
+ | definicao: "Consideram-se como analfabetas as pessoas maiores de 15 anos que declararam não serem capazes de ler e escrever ou que aprenderam a ler e escrever, mas esqueceram, | ||
+ | e as que apenas assinavam o próprio nome. | ||
+ | As pessoas capazes de ler e escrever um bilhete simples no idioma que conhecem são consideradas alfabetizadas.", | ||
+ | nota: [ | ||
+ | "Dados de 2010 extraídos do Banco Multidimensional de Estatísticas – BME, do IBGE, em 6 de agosto de 2012." | ||
+ | ], | ||
+ | fonte: [ | ||
+ | "Instituto Brasileiro de Geografia e Estatística – IBGE. Censo Demográfico. Resultados do Universo.", | ||
+ | "Fundação Seade." | ||
+ | ] | ||
+ | }, | ||
+ | } | ||
+ | } | ||
− | + | == Fonte == | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
'''GET''' | '''GET''' | ||
− | + | * '''Path''': /fonte | |
− | + | ||
− | * '''Path''': / | + | |
* '''Parâmetros''': código | * '''Parâmetros''': código | ||
− | + | <nowiki>* codigo = all (lista todas as fontes) </nowiki> | |
=== Sintaxe de chamada === | === Sintaxe de chamada === | ||
− | curl -X GET "http://api-perfil.seade.gov.br/v1/ | + | curl -X GET "http://api-perfil.seade.gov.br/v1/fonte/all" |
ou | ou | ||
− | curl -X GET "http://api-perfil.seade.gov.br/v1/ | + | curl -X GET "http://api-perfil.seade.gov.br/v1/fonte/{codigo}" |
− | + | ||
=== Retorno JSON === | === Retorno JSON === | ||
Linha 277: | Linha 234: | ||
Exemplo: | 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." | ||
+ | }, | ||
+ | ... | ||
+ | ] | ||
+ | } | ||
− | + | == Nota == | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | |||
− | |||
'''GET''' | '''GET''' | ||
− | + | * '''Path''': /nota | |
− | + | ||
− | * '''Path''': / | + | |
* '''Parâmetros''': código | * '''Parâmetros''': código | ||
− | + | <nowiki>* codigo = all (lista todas as notas) </nowiki> | |
− | + | ||
− | + | ||
− | + | ||
=== Sintaxe de chamada === | === Sintaxe de chamada === | ||
− | curl -X GET "http://api-perfil.seade.gov.br/v1/ | + | curl -X GET "http://api-perfil.seade.gov.br/v1/nota/all" |
ou | ou | ||
− | curl -X GET "http://api-perfil.seade.gov.br/v1/ | + | curl -X GET "http://api-perfil.seade.gov.br/v1/nota/{codigo}" |
− | + | ||
=== Retorno JSON === | === Retorno JSON === | ||
Linha 321: | Linha 277: | ||
Exemplo: | Exemplo: | ||
− | + | { | |
− | { | + | notas: [ |
− | + | { | |
− | + | codigo: "2", | |
− | + | descricao: 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." | |
− | + | } | |
− | + | ] | |
− | + | } | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + |
Edição atual tal como às 17h21min de 7 de maio de 2018
Í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 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.
URI
http://api-perfil.seade.gov.br/v1
Código HTTP de Retorno
- Sucesso: 200.
- Erro: 404.
Recursos Disponíveis
Tema
GET
- Path: /tema
- Parâmetros: código
* codigo = all (lista todos os temas)
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:
{ fontes: [ { codigo: "1", nome: "Território e População" }, { codigo: "2", nome: "Estatísticas Vitais e Saúde" }, { codigo: "3", nome: "Condições de Vida" }, .... ] }
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" }, ... }, ... ] }
Dados
GET
- Path: /dados/tema
- Parâmetros: localidade/codigo
* localidade = código da localidade
* codigo = all (lista os dados de todos os temas da localidade )
* codigo = código do tema
Sintaxe de chamada
curl -X GET "http://api-perfil.seade.gov.br/v1/dados/tema/{localidade}/all"
ou
curl -X GET "http://api-perfil.seade.gov.br/v1/dados/tema/{localidade}/{codigo}"
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", 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" }, .... ] } ] }
Variável
GET
- Path: /variavel/perfil
- Parâmetros: código
* codigo = all (lista todas as variáveis )
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: { 185: { codigo: "185", nome: "Taxa de Analfabetismo da População de 15 Anos e Mais - Censo Demográfico", unidade: "(Em %)", periodo: "1991/2000/2010", ultimo_ano: "2010", definicao: "Consideram-se como analfabetas as pessoas maiores de 15 anos que declararam não serem capazes de ler e escrever ou que aprenderam a ler e escrever, mas esqueceram, e as que apenas assinavam o próprio nome. As pessoas capazes de ler e escrever um bilhete simples no idioma que conhecem são consideradas alfabetizadas.", nota: [ "Dados de 2010 extraídos do Banco Multidimensional de Estatísticas – BME, do IBGE, em 6 de agosto de 2012." ], fonte: [ "Instituto Brasileiro de Geografia e Estatística – IBGE. Censo Demográfico. Resultados do Universo.", "Fundação Seade." ] }, } }
Fonte
GET
- Path: /fonte
- Parâmetros: código
* codigo = all (lista 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." }, ... ] }
Nota
GET
- Path: /nota
- Parâmetros: código
* codigo = all (lista todas as notas)
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:
{ notas: [ { codigo: "2", descricao: 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." } ] }