CommonsBooking verfügt über eine eigene API (Was ist die CommonsBooking API), über die ihr bequem auf entsprechende Daten zugreifen könnt oder die Daten für andere Plattformen oder Dienste zur Verfügung stellen könnt.
Die API basiert auf der in WordPress implementierten REST-API
Aktivierung der API
- Die API ist standardmäßig deaktiviert und es gibt keine Verbindungen zu externen Services oder Plattformen.. Unter Einstellungen -> CommonsBooking -> Tab: API / Export kann die API über die entsprechende Checkbox aktiviert werden.
Es stehen folgende API-Routen zur Verfügung:
Verfügbarkeit
- Beschreibung: Zeit die Verfügbarkeiten von Artikel an Standorten an
- Route: /wp-json/commonsbooking/v1/availability
- Schema: https://github.com/wielebenwir/commons-api/blob/master/commons-api.availability.schema.json
Items / Artikel
- Beschreibung: Gibt Daten zu allen veröffentlichen Artikeln inklusive der damit verknüpften Verfügbarkeiten und Standorte zurück
- Route: /wp-json/commonsbooking/v1/items
- Schema: https://github.com/wielebenwir/commons-api/blob/master/commons-api.items.schema.json
Locations / Standorte
- Beschreibung: Gibt eine Liste aller Standorte zurück inklusive der Geo-Koordinaten
- Route: wp-json/commonsbooking/v1/locations
- Schema: https://github.com/wielebenwir/commons-api/blob/master/commons-api.locations.schema.json
Projekte / Projects
- Beschreibung: Gibt die Basisdaten der WordPress-Instanz zurück
- Route: wp-json/commonsbooking/v1/projects
- Schema: https://github.com/wielebenwir/commons-api/blob/master/commons-api.projects.schema.json