Commit f8acf2ee authored by Nelso Jost's avatar Nelso Jost

Update README

parent 8e76c459
......@@ -12,7 +12,7 @@ A webapp oferece uma RESTful API para envio e acesso aos dados armazenados. Func
> Note: Objetos JSON são análogos (em geral) aos dicionários de Python.
* No advento de erros, o seguinte JSON será retornado:
** `{"Error": message}`
* `{"Error": message}`
### /get/boardhash (POST)
......@@ -71,10 +71,11 @@ Naturalmente, a tarefa pode ser automatizada por um data logger, tal como [emm-l
### /get/csv/rawsensordata/<int:board_id>
Permite a qualquer pessoa obter os dados da estação identificada por `<int:board_id>`.
* Retorna um arquivo `.csv` contendo TODOS os dados da estação, no formato:
```
DATETIME,sensor1,sensor2,...,sensorN
```
```
DATETIME,sensor1,sensor2,...,sensorN
```
Esta é uma requisição GET simples (não requer JSON) e pode ser feita em um web browser quaquer.
......@@ -83,36 +84,36 @@ Esta é uma requisição GET simples (não requer JSON) e pode ser feita em um w
Há duas opções básicas para interagir com a API:
* **Curl**
```
$ curl -i -H 'content-type: application/json' -X POST
-d '{"board_id": 3,"user_password": "1234"}'
http://dados.cta.if.ufrgs.br/emm/api/get/boardhash
HTTP/1.1 200 OK
Server: nginx/1.6.2
Date: Thu, 25 Jun 2011 21:45:12 GMT
Content-Type: application/json
Content-Length: 88
Connection: keep-alive
Set-Cookie: session=eyJfaWQiOiJhMjUwZjVhMDViMjdkMGNkOTUzN2Q4YTViYWQzODFiMiJ9.CqDqWA.5TmPTa9zus8ZVo0avVnwz-O4-Dc; Domain=.dados.cta.if.ufrgs.br; HttpOnly; Path=/
{
"board_hash": "pbkdf2:sha1:1000$rT98ercf$bf77e6ca081826cbf9fc0fab23cb93bf17fe598b"
}
```
```text
$ curl -i -H 'content-type: application/json' -X POST
-d '{"board_id": 3,"user_password": "1234"}'
http://dados.cta.if.ufrgs.br/emm/api/get/boardhash
HTTP/1.1 200 OK
Server: nginx/1.6.2
Date: Thu, 25 Jun 2011 21:45:12 GMT
Content-Type: application/json
Content-Length: 88
Connection: keep-alive
Set-Cookie: session=eyJfaWQiOiJhMjUwZjVhMDViMjdkMGNkOTUzN2Q4YTViYWQzODFiMiJ9.CqDqWA.5TmPTa9zus8ZVo0avVnwz-O4-Dc; Domain=.dados.cta.if.ufrgs.br; HttpOnly; Path=/
{
"board_hash": "pbkdf2:sha1:1000$rT98ercf$bf77e6ca081826cbf9fc0fab23cb93bf17fe598b"
}
```
* Python + excelente biblioteca **requests** (instale via `pip3`).
```
>>> import requests
>>> url = 'http://dados.cta.if.ufrgs.br/emm/api/get/boardhash'
>>> d = {'board_id': 3, 'user_password': '1234'}
>>> r = requests.post(url, json=d)
>>>> r
<Response [200]> # 200 significa "sucesso"
>>> r.json()
{'board_hash': 'pbkdf2:sha1:1000$rT98ercf$bf77e6ca081826cbf9fc0fab23cb93bf17fe598b'}
```
```text
>>> import requests
>>> url = 'http://dados.cta.if.ufrgs.br/emm/api/get/boardhash'
>>> d = {'board_id': 3, 'user_password': '1234'}
>>> r = requests.post(url, json=d)
>>>> r
<Response [200]> # 200 significa "sucesso"
>>> r.json()
{'board_hash': 'pbkdf2:sha1:1000$rT98ercf$bf77e6ca081826cbf9fc0fab23cb93bf17fe598b'}
```
## Instalação e manutenção
......@@ -254,4 +255,4 @@ app.models.board.Board
>>> boards.ls
[<Board id=1 user='admin' nickname='Pezzi' sensor_count=4>,
<Board id=2 user='admin' nickname='UFRGS' sensor_count=4>]
```
```
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment