Register new Serviceprovider
Ein Serviceanbieter ist eine Verleihorganisation, die Gemeingutartikel über eine Webplattform anbietet. Eine solche Webplattform ist über eine eindeutige Url (Link) erreichbar. Um mit der App auf die Angebote zugreifen zu können muss die Plattform die folgenden Voraussetzungen erfüllen:
- Die Plattform wird mit dem CommonsBooking Plugin betrieben
-
Für die Anzeige der Angebote:
die CommonsAPI (Bestandteil von CommonsBooking) ist aktiviert und frei zugänglich -
Für Buchen und Verwalten von Buchungen:
Eine Anmeldung an der Website und Installation des Plugins „API for CB App“.
Es gib zwei Möglichkeiten einen Serviceprovider für die App zu registrieren, über das Menü oder über den Einstellungen Dialog.
A service provider is a rental organization that offers public domain items via a web platform. Such a web platform can be accessed via a unique url (link). In order to be able to access the offers with the app, the platform must fulfill the following requirements:
- The platform is operated with the CommonsBooking plugin
-
To display the offers:
the CommonsAPI (part of CommonsBooking) is activated and freely accessible -
For booking and managing bookings:
A login to the website and installation of the “API for CB App” plugin.
There are two ways to register a service provider for the app, via the menu or via the settings dialog.
Option1: Service provider dialog via menu
Select the “New service” menu item to open the dialog box for entering the service provider’s data.
Option2: Service provider dialog via settings
Click the “New” button under “Edit service” to open the dialog box for entering the service provider’s data.
Entering the service provider’s data
01 – Link to the provider’s website
02 – Test connection
03 – Name displayed in the app for this provider
04 – Cancel without saving the entries
05 – Save the service data and continue to register account
Test connection
You can have the app test whether the url to the service provider can be reached and which access options (interfaces) it supports.
To do this, enter the url in “Register service” or via the “Edit service” settings and tap on “Test connection” (02).
Examples of the test results
Example1: All functions are supported by the service provider
Netzwerkverbindung testen
Netzwerk verfügbar
Website Verbindungstest
Link Adresse erreichbar!
REST API Verbindungstest
Rest API Adresse erreichbar!
CommonsBooking API Test
CommonsBooking API vorhanden
Login Test
App Login aktiviert
App Extension API Test
App Extension API vorhanden!
Test network connection
Determines whether this device has a network connection
Website connection test
Determines whether the url is accessible via the network
REST API connection test
Determines whether the service provider has activated the WordPress REST API
CommonsBooking API test
Determines whether the service provider has activated the CommonsAPI
Login Test
Determines whether the service provider allows login via an application password
App Extension API Test
Determines whether the extension for the CB App is installed and activated
RESULT:
The service provider’s information can be displayed in the app and bookings can be made if an account is available.
Example2: Website accessible, CommonsBooking (API) available but no Extension API
Netzwerkverbindung testen
Netzwerk verfügbar
Website Verbindungstest
Link Adresse erreichbar!
REST API Verbindungstest
Rest API Adresse erreichbar!
CommonsBooking API Test
CommonsBooking API vorhanden
Login Test
App Login aktiviert
App Extension API Test
Fehler!
In this example, the website of the url is accessible and also has the WordPress REST API and CommonsBooking including API activated. However, the extension API is not available.
This is the case, for example, with a WordPress site with CommonsBooking but without app support.
RESULT:
The service provider’s information can be displayed in the app, but booking is not possible.
Example 3: Website accessible, but without CommonsBooking (API) and Extension API
Netzwerkverbindung testen
Netzwerk verfügbar
Website Verbindungstest
Link Adresse erreichbar!
REST API Verbindungstest
Rest API Adresse erreichbar!
CommonsBooking API Test
Fehler!
Login Test
App Login aktiviert
App Extension API Test
Fehler!
In this example, the website of the url is accessible and also has the WordPress REST API activated, but CommonsBooking is not installed or the API is deactivated.
This is the case, for example, with a WordPress site without CommonsBooking (or API not activated).
RESULT:
The app cannot display information for this site, nor is booking possible.
Example4: Error in Url
Netzwerkverbindung testen
Netzwerk verfügbar
Website Verbindungstest
Bad Request
REST API Verbindungstest
FormatException: Unexpected character)
CommonsBooking API Test
Fehler!
Login Test
Fehler!
App Extension API Test
Fehler!
No connection can be established to the specified url.
This is the case, for example, if the url is incorrect or does not exist.
RESULT:
The app cannot display information for this site and booking is not possible.