Mudanças entre as edições de "API-GOVERNO-ABERTO-SP"
| (3 edições intermediárias de um usuário não apresentadas) | |||
| Linha 1: | Linha 1: | ||
'''Governo Aberto SP - REST API''' | '''Governo Aberto SP - REST API''' | ||
| − | Acesse informações sobre os conjuntos de dados e seus recursos através de uma API poderosa. | + | |
| + | ''Acesse informações sobre os conjuntos de dados e seus recursos através de uma API poderosa.'' | ||
| Linha 16: | Linha 17: | ||
'''Ferramentas para utilizar o sistema REST API''' | '''Ferramentas para utilizar o sistema REST API''' | ||
| + | |||
'''Clientes http e bibliotecas''' | '''Clientes http e bibliotecas''' | ||
| Linha 49: | Linha 51: | ||
| − | ''' | + | '''EXEMPLOS DE CONSULTAS''' |
| + | |||
'''Obter uma lista de conjuntos de dados em JSON''' | '''Obter uma lista de conjuntos de dados em JSON''' | ||
| Linha 56: | Linha 59: | ||
| − | Obter uma lista de | + | '''Obter uma lista de temas em JSON''' |
| − | curl http://catalogo.governoaberto.sp.gov.br/api/3/action/ | + | curl http://catalogo.governoaberto.sp.gov.br/api/3/action/group_list -d'{}' |
| − | Obter a descrição de um determinado conjunto de dados em JSON | + | '''Obter a descrição de um determinado conjunto de dados em JSON''' |
curl http://catalogo.governoaberto.sp.gov.br/api/3/action/package_show -d'{"id": "229-produtos-movimentados-no-porto-de-sao-sebastiao"}' | curl http://catalogo.governoaberto.sp.gov.br/api/3/action/package_show -d'{"id": "229-produtos-movimentados-no-porto-de-sao-sebastiao"}' | ||
| − | Procurar conjuntos de dados ou recursos que correspondem a uma consulta | + | '''Procurar conjuntos de dados ou recursos que correspondem a uma consulta''' |
curl http://catalogo.governoaberto.sp.gov.br/api/3/action/package_search -d'{"q": "educação"}' | curl http://catalogo.governoaberto.sp.gov.br/api/3/action/package_search -d'{"q": "educação"}' | ||
Edição atual tal como às 15h28min de 6 de dezembro de 2016
Governo Aberto SP - REST API
Acesse informações sobre os conjuntos de dados e seus recursos através de uma API poderosa.
Uma forma de acessar as informações do Portal Governo Aberto SP é mediante o sistema REST API. As informações obtidas podem ser utilizadas com um código externo para consultar a API do portal.
Para as atividades de programação, a API está disponível na seguinte URL: http:// http://catalogo.governoaberto.sp.gov.br/api/3/
O Governo Aberto SP baseia-se numa aplicação de CKAN, cujo site contém documentação completa sobre a API. Mais informações consulte a documentação principal da [<a href="http://docs.ckan.org/en/latest/api/">CKAN Data API</a>].
O formato das mensagens para o corpo quer dos pedidos quer das respostas é o JSON (especificado em RFC 4627). Seguem-se alguns exemplos de utilização do sistema REST API na sua aplicação.
Ferramentas para utilizar o sistema REST API
Clientes http e bibliotecas
curl é uma ferramenta de linha de comandos http genérica que pode ser utilizada para interrogar a API. Consulte os exemplos abaixo para ver como pode ser utilizada.
Existem extensões para os navegadores mais utilizados que permitem fazer consultas à API no próprio navegador como, por exemplo Postman para Google Chrome ou RESTClient para Mozilla Firefox.
A maioria das linguagens de programação pode ser utilizada para fazer uma consulta à API, desde que exista uma componente de conexão http compatível, como é o caso de Jersey para Java.
Ferramentas especializadas
Foram desenvolvidas algumas ferramentas especializadas, que podem ser utilizadas para facilitar a utilização do sistema REST API:
Python ckanclient — CKAN Python Client (o cliente oficial gerido pela equipa de CKAN, em Python)
Java Ckan_client-J
Ruby CKAN Ruby
Javascript ckanjs
PHP Ckan_client-PHP
EXEMPLOS DE CONSULTAS
Obter uma lista de conjuntos de dados em JSON
curl http://catalogo.governoaberto.sp.gov.br/api/3/action/package_list -d'{}'
Obter uma lista de temas em JSON
curl http://catalogo.governoaberto.sp.gov.br/api/3/action/group_list -d'{}'
Obter a descrição de um determinado conjunto de dados em JSON
curl http://catalogo.governoaberto.sp.gov.br/api/3/action/package_show -d'{"id": "229-produtos-movimentados-no-porto-de-sao-sebastiao"}'
Procurar conjuntos de dados ou recursos que correspondem a uma consulta
curl http://catalogo.governoaberto.sp.gov.br/api/3/action/package_search -d'{"q": "educação"}'
