Aanmelden  •  Registreren
Zelf een MijnTuin.org account aanmaken

Specificaties van de MijnTuin.org API voor ontwikkelaars

De MijnTuin REST Web Service API laat u toe om onze diensten in uw applicatie te integreren.
Onderstaande documentatie beschrijft de verschillende mogelijkheden en features die momenteel beschikbaar zijn.

  • Verbinding met de API
  • Beschikbare data formaten
  • Mogelijke opties
  • Voorbeelden
  • Foutmeldingen


Verbinding met de API

De verbinding met onze API verloopt via het Internet (HTTP requests). Om gebruik te kunnen maken van onze API heeft u een actieve account nodig bij MijnTuin.org (http://www.mijntuin.org/join)

Authenticatie met de website werkt volgens het OAuth principe. U dient eerst de nodige tokens aan te vragen via http://www.mijntuin.org/dev/.



Beschikbare data formaten

De MijnTuin.org API is beschikbaar in 2 data formaten: JSON (is standaard) en XML



Mogelijke opties

GET users/all (Parameters: page, per_page)
GET users/top (Parameters: page, per_page)
GET users/show (Parameters: user_id)
POST users/register (Parameters: firstname, lastname, ...) Vereist authenticatie
GET plants/all (Parameters: page, per_page)
GET plants/top (Parameters: page, per_page)
GET plants/show (Parameters: plant_id)
GET plants/actions (Parameters: plant_id)
GET garden/show (Parameters: user_id)
GET badges/users (Parameters: badge_id)


Request Parameters:

  • page = de opgevraagde pagina
  • per_page = aantal records die je terugkrijgt per request
  • user_id = de unieke ID van de gebruiker
  • plant_id = de unieke ID van de plant
  • badge_id = de unieke ID van de badge



Voorbeelden

JSON

http://dev.mijntuin.org/api/users/all.json
http://dev.mijntuin.org/api/users/top.json
http://dev.mijntuin.org/api/users/show.json?user_id=22
http://dev.mijntuin.org/api/plants/show.json?plant_id=35
http://dev.mijntuin.org/api/plants/top.json
http://dev.mijntuin.org/api/plants/actions.json?plant_id=35
http://dev.mijntuin.org/api/garden/show.json?user_id=22
http://dev.mijntuin.org/api/badges/users.json?badge_id=2

XML

http://dev.mijntuin.org/api/users/all.xml
http://dev.mijntuin.org/api/users/top.xml
http://dev.mijntuin.org/api/users/show.xml?user_id=22
http://dev.mijntuin.org/api/plants/show.xml?plant_id=35
http://dev.mijntuin.org/api/plants/top.xml
http://dev.mijntuin.org/api/plants/actions.xml?plant_id=35
http://dev.mijntuin.org/api/garden/show.xml?user_id=22
http://dev.mijntuin.org/api/badges/users.xml?badge_id=2



Foutmeldingen

Een fout of onvolledige request zal volgende output teruggeven:

<error>Not Found</error>