API - Recursos de locais
Os recursos de locais são parte da API que facilitam o acesso aos dados de cada local marcado pelo Plante Aqui.
GET /api/position
Limit
O parâmetro limit retorna os dados em uma quantidade limitada de resultados, aceita apenas números inteiros.
http://www.planteaqui.org/api/position?limit=10
Lat & Long
Utilize os parâmetros Lat&Long para buscar informações de um ponto em específico.
http://localhost:8082/api/position?lat=-23.3178437&lon=-51.1828048
Callback
O parâmetro callback permite que uma função de callback seja específicada no retorno positivo da requisição
http://localhost:8082/api/position?callback=minha_funcao
POST /api/position
Ao inserir um ponto, casa o local já exista, a ação irá aumentar um contador chamado "pontos" que é usado para medir a quantidade de pessoas que gostariam de que ali fosse plantada uma árvore, automáticamente o usuário também irá seguir aquele local
ll
uma string contendo latitude e longitude, separados por virgula. Os números devem ter pontos ao invés de virgulas para separar suas casas decimais.
http://www.planteaqui.org/api/position?ll=-22.00000,-22.020202
user
nick do usuário que está enviando o local.
http://localhost:8082/api/position?ll=-22.00000,-22.020202&user=tad-dev
tipo
O parâmetro tipo dar uma caracteristica única para aquele ponto. Obs: existem algumas palavras que são reservadas para uso da aplicação, que são as seguintes. "desmarcado, plantado, plante_aqui(padrão em todos locais)"
http://localhost:8082/api/position?ll=-22.00000,-22.020202&user=tad-dev&tipo=sombra
message
O parâmetro message, permite anexar uma mensagem única para aquele ponto e para o usuário. Obs: o ponto marcado pode ter as mensagens de diversos usários.
http://localhost:8082/api/position?ll=-22.00000,-22.020202&user=tad-dev&tipo=sombra
DELETE /api/position
Para apagar um local, o usuário tem que ser o mesmo que marcou aquele ponto. Caso exista mais pessoas que marcaram aquele ponto, o local passa a ser do usuário seguinte.
O parâmetro para apagar tem que ser enviado no cabeçalho da aplicação:
{ position: -22.00000,-22.020202 }
position
uma string contendo latitude e longitude, separados por virgula. Os números devem ter pontos ao invés de virgulas para separar suas casas decimais.
Console
Use o console e teste os recursos da API:
Obs: Quando logado, você pode requisitar informações de usuários com perfil público.