Mudanças entre as edições de "API-GUIA-SERVICOS"
(→Município) |
(→Nota) |
||
Linha 141: | Linha 141: | ||
* '''Parâmetros''': código | * '''Parâmetros''': código | ||
− | + | <nowiki> É obrigatório informar o "id" (código) ou a palavra "all" para listar todos os registros.</nowiki> | |
Edição das 19h02min de 25 de abril de 2016
Í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 atualizada, do Guia de Serviços. 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-guiaserv.seade.gov.br/v1
Código HTTP de Retorno
- Sucesso: 200.
- Erro: 404.
Recursos Disponíveis
Órgãos
GET
- Path: /orgao/
- Parâmetros: id
É obrigatório informar o "id" (código) ou a palavra "all" para listar todos os registros.
Sintaxe de chamada
curl -X GET "http://api-guiaserv.seade.gov.br/v1/orgao/all"
ou
curl -X GET "http://api-guiaserv.seade.gov.br/v1/orgao/{id}"
Retorno JSON
Exemplo:
{ "orgao": [ { "Nome": "Secretaria da Administração Penitenciária", "ID_Orgao": "11", "Condicao": "1" } ] }
Obs.: Condicao = 1 (órgao ativo) e Condicao = 0 (órgão inativo)
Prestador
GET
- Path: /prestador/
- Parâmetros: id
É obrigatório informar o "id" (código) ou a palavra "all" para listar todos os registros.
Sintaxe de chamada
curl -X GET "http://api-guiaserv.seade.gov.br/v1/prestador/all"
ou
curl -X GET http://api-guiaserv.seade.gov.br/v1/prestador/{id}"
Retorno JSON
Exemplo:
{ "prestador": [ { "ID_Prestador": "310", "Nome": "Procuradoria Geral do Estado - Sede", "ID_Orgao": "35", "Nome_Secretaria": "Procuradoria Geral do Estado", "Endereco": "Rua Pamplona", "EndNumero": "227", "EndComplemento": "6º andar", "CEP": "01405902", "Municipio_IBGE": "3550308", "Nome_Municipio": "São Paulo", "Telefone": "11-3372-6438", "Ramal": null, "Fax": "11-3372-6498", "HomePage": "www.pge.sp.gov.br", "Email": "arinaldi@sp.gov.br", "Condicao": "1" } ] }
Obs.: Condicao = 1 (prestador ativo) e Condicao = 0 (prestador inativo)
Município
GET
- Path: /municipio/
- Parâmetros: id
É obrigatório informar o "id" (código) ou a palavra "all" para listar todos os registros.
Sintaxe de chamada
curl -X GET "http://api-guiaserv.seade.gov.br/v1/municipio/all"
ou
curl -X GET "http://api-guiaserv.seade.gov.br/v1/municipio/{id}"
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
É obrigatório informar o "id" (código) ou a palavra "all" para listar todos os registros.
Sintaxe de chamada
curl -X GET "http://api-guiaserv.seade.gov.br/v1/nota"
ou
curl -X GET "http://api-guiaserv.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-guiaserv.seade.gov.br/v1/variavel/{codigo}"
ou
curl -X GET "http://api-guiaserv.seade.gov.br/v1/variavel?offset=0&limit=10"
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>." ] } }