Hoe kan ik jullie API's gebruiken?

De webservice maakt gebruik van de techniek REST. Hierbij worden verschillende formaten ondersteund, maar is JSON formaat het standaard en aanbevolen formaat.

De webservice stelt een derde partij is staat het i-Reserve model te gebruiken in de breedste zin van het woord. Gegevens ophalen, maar ook muteren en aanmaken is mogelijk.

De start locatie is de URL van de omgeving. Is de door u gebruikte URL om van het beheerpaneel gebruik te maken https://uwdomein.i-reserve.nl/admin.php, dan is de API URL https://uwdomein.i-reserve.nl/api/rest/.

Hieraan voegen we de entiteit aan toe. In het geval van reserveringen, is dit booking. De url wordt dan https://uwdomein.i-reserve.nl/api/rest/booking/

De volgende stap is het bepalen van de actie. Deze komt in REST vaak overeen met de CRUD matrix. Het ophalen van informatie gaat via een GET request en het bijwerken via een PUT. Een reserveringsnummer wordt via de URL meegegeven. De URL om een reservering te bekijken wordt dan:

GET https://uwdomein.i-reserve.nl/api/rest/booking/1284 

Resultaat:

{  
   "booking_id":"1582",
   "object_desc":"IT015: Albicocco",
   "status":"Dummy",
   "fromdate":"Sat Jul 09, 2011",
   "tilldate":"Sat Jul 09, 2011",
   "number":"1"
}

Webservice gebruiken en/of testen

Het voordeel van REST is dat deze eenvoudig in het gebruik is. Een browser is afdoende om de webservice te gebruiken en/of te testen.