Vicon Web API
Tópicos da Referência
Descrição dos parâmetros
Autenticação
Listagem
Inserção/Remoção de registros
Posicionamento de usuário
Consulta a registros
Sensores de Monitoramento
Parâmetro |
Descrição |
action |
Ação requisitada |
token |
Chave de temporária de operação acesso |
email |
E-mail de usuário cadastrado no projeto
|
password |
Senha de acesso do usuário <email>
no projeto |
pid |
Número identificador único do projeto no projeto |
idform |
Número identificador único do formulário no projeto |
idrecord |
Número identificador do registro no projeto |
output |
Formato de impressão do resultado do processamento. Valores possíveis: xml (default) | json |
Descrição
Autenticar para receber um token a partir de um <email>, <password>
Parâmetros de entrada
email, password
Exemplo de Chamada
https://viconsaga.com.br/api.php?action=login&email=user@domain.com&password=12345
Retornos
Código |
Descrição |
-1 |
-1Incomplete parameters. Parameters required for this call: action, email, password
|
-2 |
-2Invalid email and/or password
|
abcdefgh |
abcdefghToken successfully generated. Valid for 120 minutes.
|
Descrição
Listar projetos do usuario a partir de um <token>
Parâmetros de entrada
email, password
Exemplo de Chamada
https://viconsaga.com.br/api.php?action=listuserprojects&token=abcdefgh
Retornos
Código |
Descrição |
-1 |
-1Incomplete parameters. Parameters required for this call: token
|
-2 |
-2Invalid token (expired after 120 minutes of its generation).
|
1 |
-2
Invalid token (expired after 120 minutes of its generation).
|
Descrição
Listar usuários de um projeto <pid>
Parâmetros de entrada
pid, token (obrigatório quando projeto não é público)
Exemplo de Chamada
https://viconsaga.com.br/api.php?action=listprojectusers&pid=4&token=abcdefgh
Retornos
Código |
Descrição |
-1 |
-1Incomplete parameters. Parameters required for this call: action, pid [,token]
|
-2 |
-2Invalid token (expired after 120 minutes of its generation).
|
-3 |
-3Users cannot be listed without a token generated by an user from this project. This project is not open for public access. Thus, it is necessary to generate a token by command login
|
1 |
1
4
9
xavier.lageop@gmail.com
1
2014-09-19 12:03:09
educacaolibertaria
-22.7981
-43.199
30
1
united
004060
0059.jpg
3
3
1
1
1
1
30
2024-10-09 00:04:13
0
1
0
0
16
Brazil
br
BRL
19/09/14
09/10/2024 00:04
08/11/2024
https://viconsaga.com.br/?idProject=4
https://viconsaga.com.br/educacaolibertaria
https://viconsaga.com.br/educacaolibertaria-embed
00131d
e6ecef
xavier.lageop
img/logo.png
projects/4/0059.jpg
-
-
-
004060
f7f9fa
4d7990
00334d
003d5b
4085
4
1
1
2016-04-20 12:59:44
API User
user@domain.com
20/04/16
user
Visualization
-
0
General
0
3087
4
3
1
2015-11-23 12:46:56
Rosangela
r.sangelag@hotmail.com
23/11/15
r.sangelag
View, Edit, Insert, Delete
23/11/15 14:01
2
General
0
1341
4
3
1
2014-11-25 16:18:33
Filipe Silva
filipenjord@gmail.com
25/11/14
filipenjord
View, Edit, Insert, Delete
09/12/14 22:21
1
General
0
1340
4
3
1
2014-11-25 16:17:55
Fernanda Santos
fernanda.guilherme8@gmail.com
25/11/14
fernanda.guilherme8
View, Edit, Insert, Delete
09/12/14 19:29
2
General
0
1339
4
3
1
2014-11-25 16:17:03
Roberta Medeiros
robertamlmedeiros@hotmail.com
25/11/14
robertamlmedeiros
View, Edit, Insert, Delete
08/12/14 20:49
6
General
0
1334
4
3
1
2014-11-20 14:38:14
OscarFirme
oscarfirme@yahoo.com.br
20/11/14
oscarfirme
View, Edit, Insert, Delete
20/11/14 14:39
1
General
0
1327
4
3
1
2014-11-11 13:53:11
Leonardo Oliveira da Silva
leugeo25@gmail.com
11/11/14
leugeo25
View, Edit, Insert, Delete
18/12/14 00:00
2
General
0
1325
4
3
1
2014-11-06 15:20:49
Flavio
flaviomb15@hotmail.com
06/11/14
flaviomb15
View, Edit, Insert, Delete
-
0
General
0
1320
4
3
1
2014-10-21 15:03:47
Thayanne
thayannefroes4@gmail.com
21/10/14
thayannefroes4
View, Edit, Insert, Delete
09/12/14 11:20
1
General
0
1319
4
3
1
2014-10-21 15:03:10
Rafael
rafael.paschoa92@hotmail.com
21/10/14
rafael.paschoa92
View, Edit, Insert, Delete
08/12/14 11:54
1
General
0
1318
4
3
1
2014-10-21 15:02:32
Caio
caiocruzeiror@gmail.com
21/10/14
caiocruzeiror
View, Edit, Insert, Delete
10/11/14 20:17
5
General
0
1317
4
3
1
2014-10-21 15:02:01
Mauricio
omauriciohernandez@gmail.com
21/10/14
omauriciohernandez
View, Edit, Insert, Delete
12/11/14 17:06
1
General
0
1316
4
3
1
2014-10-21 15:01:19
Vitor
vitor4068@oi.com.br
21/10/14
vitor4068
View, Edit, Insert, Delete
08/12/14 11:53
3
General
0
1315
4
3
1
2014-10-21 15:00:38
Monique
monique.patricia.sousa@gmail.com
21/10/14
monique.patricia.sousa
View, Edit, Insert, Delete
08/12/14 18:48
2
General
0
1314
4
3
1
2014-10-21 14:59:25
Silvia
silviat.alexandre@hotmail.com
21/10/14
silviat.alexandre
View, Edit, Insert, Delete
-
0
General
0
22
4
3
1
2014-10-14 17:47:31
profgoess@gmail.com
14/10/14
profgoess
View, Edit, Insert, Delete
-
0
General
0
13
4
3
1
2014-09-19 12:09:27
biajacques91@gmail.com
19/09/14
biajacques91
View, Edit, Insert, Delete
30/09/14 16:01
0
General
0
12
4
4
1
2014-09-19 12:08:58
ANDRESSA
andressakne@gmail.com
19/09/14
andressakne
Project Manager
17/11/14 15:31
2
General
0
11
4
3
1
2014-09-19 12:08:47
historiador_ufrj@yahoo.com.br
19/09/14
historiador_ufrj
View, Edit, Insert, Delete
18/02/24 19:05
0
General
0
9
4
4
1
2014-09-19 12:03:09
xavier.lageop@gmail.com
19/09/14
xavier.lageop
Project Manager
05/08/19 22:24
11
General
0
|
Descrição
Listar formulário de um projeto <pid>
Parâmetros de entrada
pid, token (obrigatório quando projeto não é público)
Exemplo de Chamada
https://viconsaga.com.br/api.php?action=listprojectforms&pid=4&token=abcdefgh
Retornos
Código |
Descrição |
-1 |
-1Incomplete parameters. Parameters required for this call: action, pid, [token]
|
-2 |
-2Invalid token (expired after 120 minutes of its generation).
|
-3 |
-3Forms cannot be listed without a token generated by an user from this project. This project is not open for public access. Thus, it is necessary to generate a token by command login
|
1 |
1
8
4
1
2014-09-22 11:32:40
2014-09-22 11:32:40
1
1
educacaolibertaria
22/09/2014 11:32
22/09/2014 11:32
img/markers/1.png
https://viconsaga.com.br/share/8
9
9
4
1
2014-10-12 08:43:31
2014-10-12 08:43:31
1
1
educacaolibertaria
12/10/2014 08:43
12/10/2014 08:43
img/markers/1.png
https://viconsaga.com.br/share/9
18
10
4
1
2014-10-12 08:44:17
2014-10-12 08:44:17
1
1
educacaolibertaria
12/10/2014 08:44
12/10/2014 08:44
img/markers/1.png
https://viconsaga.com.br/share/10
13
|
Descrição
Obter informações acerca do formulário <idform>. Resultado no formato XML com informações dos campos do formulário.
Parâmetros de entrada
idform, token (obrigatório quando projeto não é público)
Exemplo de Chamada
https://viconsaga.com.br/api.php?action=listforminfo&idform=8&token=abcdefgh
Retornos
Código |
Descrição |
-1 |
-1Incomplete parameters. Parameters required for this call: idform, idrecord, [token]
|
-2 |
-2Invalid token (expired after 120 minutes of its generation).
|
-3 |
-3Record cannot be listed without a token generated by an user from this project. This project is not open for public access. Thus, it is necessary to generate a token by command login
|
1 |
|
Descrição
Inserir registros de um formulário do projeto (indicado pelo parâmtro form (via GET), com dados no formato GeoJSON.
O campo idFormField da propriedade fields representa o valor do código do campo do formulário. Para obter informação acerca da estrutura de um formulário o usuário poderá executar a requisição listforminfo.
Caso processado com sucesso, como saída retorna o id do registro criado.
Parâmetros de entrada
idform, token (via GET); data (via POST)
Exemplo de Chamada
https://viconsaga.com.br/api.php?action=insertrecords&idform=1&token=abcdefgh
Campo Data:
{"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [125.6, 10.1]
},
"properties": {
"fields": [
{"idFormField": "1", "value": "João da Silva"},
{"idFormField": "2", "value": "Avenida Presidente Vargas, 234"},
{"idFormField": "3", "value": "10"}
],
"attachments": [
{"url": "http://www.viconsaga.com.br/files/abcd.jpg", "title": "Picture 1"},
{"url": "http://www.viconsaga.com.br/files/worksheet.xlsx", "title": "Excel Worksheet"},
{"url": "http://www.viconsaga.com.br/files/workbook.pdf", "title": "User Manual"}
]
}
}
]
}
Retornos
Código |
Descrição |
-1 |
-1Incomplete parameters. Parameters required for this call: idform, lat, lng, data, token
|
-2 |
-2Invalid token (expired after 120 minutes of its generation).
|
-4 |
-4Record could not be created due to user level limitation. User access level must be >= 3.
|
-5 |
-5Form does not exist.
|
-6 |
-6Fail! Exceeded daily creation quota (100 records/day).
|
1 |
11Record successfully created!
|
Descrição
Remover registro <idrecord>. Não é necessário especificar o <pid> e <userid> porque ambas informações estão vinculadas ao <token> (parâmetro obrigatório para esta função).
Parâmetros de entrada
idrecord, token
Exemplo de Chamada
https://viconsaga.com.br/api.php?action=deleterecord&idrecord=1&token=abcdefgh
Retornos
Código |
Descrição |
-1 |
-1Incomplete parameters. Parameters required for this call: idform, idrecord, token
|
-2 |
-2Invalid token (expired after 120 minutes of its generation).
|
-4 |
-4Record cannot be delete due to access level limitation.
|
-5 |
-5Record does not exist!
|
1 |
1Record successfully deleted!
|
Descrição
Inserir nova posição de rota de usuário em <lat> e <lng>. Não é necessário especificar o <pid> e <userid> porque ambas informações estão vinculadas ao <token> (parâmetro obrigatório para esta função).
Parâmetros de entrada
lat, lng, token
Exemplo de Chamada
https://viconsaga.com.br/api.php?action=insertuserposition&lat=-22.965644300334535&lng=-43.17431688308716&token=abcdefgh
Retornos
Código |
Descrição |
-1 |
-1Incomplete parameters. Parameters required for this call: lat, lng, token
|
-2 |
-2Invalid token (expired after 120 minutes of its generation).
|
-4 |
-4User position could not be inserted due to access level limitation
|
1 |
1User position successfully inserted!
|
Descrição
Gerar relatório de todos os registros do projeto, em um dos seguintes formatos:
kml - Google Earth
xls - Microsoft Excel, Open Office, BrOffice
xml - eXtensible Markup Language é uma recomendação da W3C para gerar linguagens de marcação para necessidades especiais
html - Hypertext Markup Language
Resultado no formato especificado pelo parâmetro <ext>
Parâmetros de entrada
pid, ext, token (obrigatório quando projeto não é público)
Exemplo de Chamada
https://viconsaga.com.br/api.php?action=generatereport&pid=4&ext=kml&token=abcdefgh
Retornos
Código |
Descrição |
-1 |
-1Incomplete parameters. Parameters required for this call: pid, ext, [token]
|
-2 |
-2Invalid token (expired after 120 minutes of its generation).
|
-3 |
-3Report cannot be listed without a token generated by an user from this project. This project is not open for public access. Thus, it is necessary to generate a token by command login
|
1 |
1
Report successfully generated!
http://localhost/viconsaga/tmp/1-19-06-2014 12-58.kml
|
Descrição
Obter informações de um registro <idrecord>. Resultado no formato XML com informações sobre o registro.
Parâmetros de entrada
idrecord, token (obrigatório quando projeto não é público)
Exemplo de Chamada
https://viconsaga.com.br/api.php?action=recordinfo&idrecord=1&token=abcdefgh
Retornos
Código |
Descrição |
-1 |
-1Incomplete parameters. Parameters required for this call: pid, lat, lng, radius, [token]
|
-2 |
-2Invalid token (expired after 120 minutes of its generation).
|
-3 |
-3Records cannot be listed without a token generated by an user from this project. This project is not open for public access. Thus, it is necessary to generate a token by command login
|
-5 |
-5Record does not exist!
|
1 |
3649
1
101
1
1
8
2014-05-21 02:09:42
2014-05-21 02:09:42
1
CBMERJ
185
1
185.png
Tiago Marino
tiagomarino@hotmail.com
21/05/2014 02:09
21/05/2014 02:09
img/markers/185.png
http://localhost/viconsaga/img/markers/185.png
103251
3649
-22.907548
-43.563438
1
Web
img/devices/1.png
-22.907548
-43.563438
-1
7465995,54
647331,97
23K
|
Descrição
Obter todos os registro de um projeto <pid> a um raio <radius> de um ponto <lat>, <lng>, contendo a palavra-chave <keyword> (opcional). Resultado no formato XML com informações sobre os registros encontrado.
[OPCIONAL] Utilize o parâmetro <idusers> para retornar somente os registros criados ou atualizados por um usuário específico.
[OPCIONAL] Utilize o parâmetro <idforms> para retornar somente os registros de um formulário específico.
[OPCIONAL] Utilize o parâmetro <fromdate> para retornar somente os registros criados ou atualizados a partir de uma determinada data/hora. Formato: YYYY-MM-DD HH:MM:SS.
[OPCIONAL] Utilize o parâmetro <todate> para retornar somente os registros criados ou atualizados até uma determinada data/hora. Formato: YYYY-MM-DD HH:MM:SS.
[OPCIONAL] Utilize o parâmetro <datetype> para determinadar se os parâmetros <fromdate> e <todate> se referem à data de criação (=1) ou de atualização (=2).
[OPCIONAL] Utilize o parâmetro <files> para retornar somente os registros com <files> ou mais arquivos anexos.
[OPCIONAL] Utilize o parâmetro <page> para marcar a pagina (início em 0) dos registros. Caso o parâmetro seja omitido, a consulta retornará a primeira página de registros.
[OPCIONAL] Utilize o parâmetro <limit> para limitar a quantidade de registros retornados por página.
Esta consulta retorna até 100 registros por chamada.
Parâmetros de entrada
token (obrigatório quando projeto não é público), pid, lat, lng, radius, keyword (opcional), idusers (opcional), idforms (opcional), fromdate (opcional), todate (opcional), fromdate (opcional), datetype (opcional), files (opcional), page (opcional), limit (opcional)
Parâmetros da busca por raio
Exemplo de Chamada
https://viconsaga.com.br/api.php?action=searchradius&pid=4&lat=-23.24325525&lng=-43.24325525&radius=40000000&page=0&limit=2&token=abcdefgh
Retornos
Código |
Descrição |
-1 |
-1Incomplete parameters. Parameters required for this call: pid, lat, lng, radius, keyword, [token]
|
-2 |
-2Invalid token (expired after 120 minutes of its generation).
|
-3 |
-3Records cannot be listed without a token generated by an user from this project. This project is not open for public access. Thus, it is necessary to generate a token by command login
|
1 |
-1
Incomplete parameters. Parameters required for this call: pid, latSW, lngSW, latNE, lngNE, token (for private projects)
|
Descrição
Proceder uma busca espacial por registros de um projeto <pid> dentro de um retângulo limitado por dois pontos com pares de coordenadas <latSW>, <lngSW>, <latNE>, <lngNE>, contendo a palavra-chave <keyword>. Resultado, registros em XML.
[OPCIONAL] Utilize o parâmetro <idusers> para retornar somente os registros criados ou atualizados por um usuário específico.
[OPCIONAL] Utilize o parâmetro <idforms> para retornar somente os registros de um formulário específico.
[OPCIONAL] Utilize o parâmetro <fromdate> para retornar somente os registros criados ou atualizados a partir de uma determinada data/hora. Formato: YYYY-MM-DD HH:MM:SS.
[OPCIONAL] Utilize o parâmetro <todate> para retornar somente os registros criados ou atualizados até uma determinada data/hora. Formato: YYYY-MM-DD HH:MM:SS.
[OPCIONAL] Utilize o parâmetro <datetype> para determinadar se os parâmetros <fromdate> e <todate> se referem à data de criação (=1) ou de atualização (=2).
[OPCIONAL] Utilize o parâmetro <files> para retornar somente os registros com <files> ou mais arquivos anexos.
[OPCIONAL] Utilize o parâmetro <page> para marcar a pagina (início em 0) dos registros. Caso o parâmetro seja omitido, a consulta retornará a primeira página de registros.
[OPCIONAL] Utilize o parâmetro <limit> para limitar a quantidade de registros retornados por página.
Esta consulta retorna até 100 registros por chamada.
Parâmetros de entrada
token (obrigatório quando projeto não é público), pid, latlatSW, lngSW, latNE, lngNE, keyword (opcional), idusers (opcional), idforms (opcional), fromdate (opcional), todate (opcional), fromdate (opcional), datetype (opcional), files (opcional), page (opcional), limit (opcional)
Parâmetros da busca por retângulo
Exemplo de Chamada
https://viconsaga.com.br/api.php?action=searchrectangle&pid=4&latSW=-90&lngSW=-180&latNE=90&lngNE=180&keyword=as&limit=2&token=abcdefgh
Retornos
Código |
Descrição |
-1 |
-1Incomplete parameters. Parameters required for this call: pid, latSW, lngSW, latNE, lngNE, [token]
|
-2 |
-2Invalid token (expired after 120 minutes of its generation).
|
-3 |
-3Records cannot be listed without a token generated by an user from this project. This project is not open for public access. Thus, it is necessary to generate a token by command login
|
1 |
-1
Incomplete parameters. Parameters required for this call: pid, latSW, lngSW, latNE, lngNE, token (for private projects)
|
Descrição
Estabelecer o servico WFS para a utilização dos dados em outras aplicações que suportam este protocolo (QGIS, GeoServer, ESRI ArcGIS, INPE Spring...).
Utilize o parâmetro "summary" (=1) para retornar carregar registros SOMENTE com informações básicas (sem campos dos formulários).
ATENÇÃO: O carregamento dos detalhes de muitos registros implica em maior tempo para o processamento da resposta. Portanto, caso sua requisição tenha muitos registros e o sistema esteja demorando, É RECOMENDÁVEL que passe o parâmetro summary=1 para agilizar o retorno
CARREGANDO MUITOS DADOS NO QUANTUM GIS: Caso a quantidade de registros a ser carregadas seja muito grande você deve reconfigurar o parâmetro Timout no QGIS.
Para isto, clique no menu Configurações->Opões... e aumente o valor do timeout e o valor do cache de dados, conforme destacado na ilustração abaixo.
QGIS: Aumentando o timeout e cache para requisição de grandes volumes de dados.
Parâmetros de entrada
pid, email, password (email e password obrigatórios quando dados do projeto não são abertos ao público), summary (opcional)
Exemplo de Chamada
https://viconsaga.com.br/api.php?action=wfs&pid=4&email=user@domain.com&password=12345
Retornos
Código |
Descrição |
-1 |
-1Incomplete parameters. Parameters required for this call: pid, email, password
|
-2 |
-2Invalid email and/or password
|
1 |
PERCEPÇÕES AMBIENTAIS ENSINO MÉDIO
percepcoes_ambientais_ensino_medio_8
9 objects
EPSG:4326
PERCEPÇÕES AMBIENTAIS GRADUAÇÃO
percepcoes_ambientais_graduacao_9
18 objects
EPSG:4326
PERCEPÇÕES AMBIENTAIS PÓS GRADUAÇÃO
percepcoes_ambientais_pos_graduacao_10
13 objects
EPSG:4326
|
Descrição
Receber dados de um sensor de monitoramento ambiental e inserir no banco de dados da plataforma
Parâmetros de entrada
- token - Verifcar na Gestão de Sensores da Plataforma
- Dados - Enviados no cabeçalho do método POST. Ex.: {"parameters":{"wind":100,"temperature":34,"humidity":97}}
Exemplo de Chamada
https://viconsaga.com.br/api.php?action=sensor-data-insert&token=abcdefghij
POST HEADERS: {"parameters":{"wind":100,"temperature":34,"humidity":97}}
Retornos
Código |
Descrição |
-1 |
-1Incomplete parameters. Parameters required for this call: id, token
|
-2 |
-2Invalid token (expired after 120 minutes of its generation).
|
-4 |
-4User position could not be inserted due to access level limitation
|
1 |
|