API Anbindung
Nutze die Vorteile der bookyt API und eröffne dir viele neue Möglichkeiten
Die bookyt API
verbindet deine Systeme
Mit der API verknüpfst du deine eigenen Anwendungen mit bookyt. Den API Schlüssel dafür legst du im bookyt Backend fest. Wir zeigen dir wie es geht.
Welche Daten kann ich mit der bookyt API auslesen?
1. Verfügbare Artikel auslesen
Um die für das Internet verfügbare Artikelliste abzurufen verwende getArtikel als Aktion. Das Antwortarray beinhaltet die Artikel-ID und die dazugehörige Bezeichnung.
Beispiel api.php?call=articles
2. AGBs ermitteln
Um die aktuellen AGBs abzufragen verwendet man den Parameter call=tac
Beispiel api.php?call=tac
3. Mietartikel auslesen
Um die Mietartikel abzufragen, verwendet man den Parameter call=ressources
Beispiel api.php?call=ressources
Mögliche optionale Parameter sind:
category_id die ID der Fahrzeuggruppe. Zu finden unter Verwaltung -> Gruppen -> Detaileintrag der Gruppe
station_id die ID der Station. Zu finden unter Verwaltung -> Stationen
4. Schäden auslesen
Um die Schäden abzufragen verwendet man den Parameter call=damages
Beispiel api.php?call=damages&fahrzeug_id=1234
Pflichtangabe ist die Fahrzeug-ID. Diese findest du im Backend unter Verwaltung -> Fahrzeuge
5. Stationen ermitteln
Call um die aktiven im Internet veröffentlichten Stationen zu erhalten. Ersetze im Call den Token!
Beispiel api.php?call=locations&token=xyz
Füge den Parameter &show=all hinzu, um auch inaktive und nicht für die Onlinebuchung freigegebene Stationen mit aufzurufen.
Verwende den Parameter &open=true
Um auch die Öffnungszeiten der nächsten 2 Jahre zurück zu bekommen
Um die für das Internet verfügbare Artikelliste abzurufen verwende getArtikel als Aktion. Das Antwortarray beinhaltet die Artikel-ID und die dazugehörige Bezeichnung.
Beispiel api.php?call=articles
2. AGBs ermitteln
Um die aktuellen AGBs abzufragen verwendet man den Parameter call=tac
Beispiel api.php?call=tac
3. Mietartikel auslesen
Um die Mietartikel abzufragen, verwendet man den Parameter call=ressources
Beispiel api.php?call=ressources
Mögliche optionale Parameter sind:
category_id die ID der Fahrzeuggruppe. Zu finden unter Verwaltung -> Gruppen -> Detaileintrag der Gruppe
station_id die ID der Station. Zu finden unter Verwaltung -> Stationen
4. Schäden auslesen
Um die Schäden abzufragen verwendet man den Parameter call=damages
Beispiel api.php?call=damages&fahrzeug_id=1234
Pflichtangabe ist die Fahrzeug-ID. Diese findest du im Backend unter Verwaltung -> Fahrzeuge
5. Stationen ermitteln
Call um die aktiven im Internet veröffentlichten Stationen zu erhalten. Ersetze im Call den Token!
Beispiel api.php?call=locations&token=xyz
Füge den Parameter &show=all hinzu, um auch inaktive und nicht für die Onlinebuchung freigegebene Stationen mit aufzurufen.
Verwende den Parameter &open=true
Um auch die Öffnungszeiten der nächsten 2 Jahre zurück zu bekommen
6. Gruppen und Kategorien
Beispiel api.php?call=category
Die Rückgabe erfolgt in einem Array mit u.a. folgenden Feldern:
Zusätzliche Informationen findest du auch in der Dokumentation.
7. Vorgangsinformationen ermitteln
Informationen zu einem Vorgang ermittelt man mit folgendem Aufruf:
Beispiel api.php?call=get_booking&no=XXX&token=xyz
Der Parameter no kann entweder die Vorgangsnummer oder der Buchungscode aus einer Onlinezahlung sein.
Die Rückgabe erfolgt in einem JSON-Array mit u.a. folgenden Feldern:
Beispiel api.php?call=category
Die Rückgabe erfolgt in einem Array mit u.a. folgenden Feldern:
| ID | ID der Untergruppe |
| files | Array mit den bei der Gruppe hinterlegten Bildern/Grafiken |
| bezeichnung | vollständige Bezeichnung der Gruppe |
| fzg_gruppe_sub | Bezeichnung der Untergruppe |
| fzg_gruppe_sub_bemerkung | In der Gruppenverwaltung hinterlegte Bemerkung |
| fzg_gruppe | Bezeichnung der Gruppe |
7. Vorgangsinformationen ermitteln
Informationen zu einem Vorgang ermittelt man mit folgendem Aufruf:
Beispiel api.php?call=get_booking&no=XXX&token=xyz
Der Parameter no kann entweder die Vorgangsnummer oder der Buchungscode aus einer Onlinezahlung sein.
Die Rückgabe erfolgt in einem JSON-Array mit u.a. folgenden Feldern:
| kunde_nachname | Nachname des Kunden |
| kunde_vorname | Vorname des Kunden |
| kunde_firma | Firma |
| vorgang_nr | Die Vorgangsnummer |
| rechnung_nr | Rechnungsnummer. Wenn sie 0 ist, wurde sie noch nicht vergeben |
| mietbeginn_datum | Datum der Anmietung |
| gesamtbetrag_brutto | Bruttobetrag |
| gesamtbetrag_netto | Nettobetrag |
| mwst_satz | Mehrwertsteuer-Satz des Vorgangs |
| offen_betrag | Höhe des offenen Betrags |
| Positionen value: Einzelbetrag bezeichnung: Positionen-Bezeichnung anzahl: Anzahl (Menge) |
Bruttobetrag |
7. Individuelle Zahlart
bookyt ermöglicht es über die Onlinebuchung eine eigene, individuelle Zahlart zu aktivieren.
Im Backend unter Verwaltung -> Frontend -> Zahlarten, die individuelle Zahlart konfigurieren:
Bezeichnung der individuellen Zahlart hinterlegen
URL des eigenen Zahlservers sowie des Passworts für die Rückleitung hinterlegen. Der Kunde wird nach Auswahl der individuellen Zahlart auf diese URL weitergeleitet. In dieser URL sind für die Rückmeldung zwei Parameter enthalten, für die erfolgreiche Rückleitung notifyurl_success und für den Fall das die Zahlung fehlgeschlagen ist notifyurl_fail - Weitere Parameter sind das Mietbeginn-Datum das mit &date=2020-12-31 an das individuelle Zahlsystem übergeben wird.
Für die Rückmeldung (notify über einen sicheren Kanal im Hintergrund) an das System muss das in den Einstellungen hinterlegte Passwort mit &pass=1234 angefügt werden, wurde nur ein Teilbetrag geleistet, kann dieser mit &amount=123.25 ebenfalls dem Notify mit beigefügt werden.
Die Ausgabe der Rückmeldung enthält die URL an die der Kunde vom individuellen Zahlsystem weitergeleitet wird, im Erfolgsfall zum Buchungssystem und wenn die Zahlung nicht ausgeführt wurde, zurück zum Warenkorb
8. Buchungen auslesen
Beispiel api.php?call=get_bookings&date=24.12.2022
Die Rückgabe erfolgt in einem JSON-Array, das je nach Anzahl der hinterlegten Buchungen sehr groß werden kann.
Weitere Parameter
9. Zahlung verbuchen
Man kann einem Vorgang eine Zahlung zuordnen. Der Bezahlbetrag muss kleiner wie der noch offene Betrag sein, ansonsten wird der Call zurückgewiesen. Der Parameter &no=12323 entspricht der Vorgangsnummer.
Beispiel api.php?aktion=set_payment&no=XXX&amount=120.12
Wenn die Zahlung erfolgreich verbucht wurde, erhält man ein TRUE bzw. FALSE, falls die Buchung nicht erfolgreich war.
Als Zahlart wird die Zahlart aus dem Feld "Standard-Zahlart" in "Zahlungen-Schnellerfassung" in den globalen Einstellungen verwendet.
10. Events auslesen
Um im Eventplanungstool hinterlegte Veranstaltungen, die für das Internet freigeschaltet sind, auszulesen, nutzt man den Event-Call von bookyt. Als Rückgabe erhält man ein JSON Objekt mit dazugehöriger Kategorie, verknüpften Dateien und Artikel.
Voraussetzung ist das aktivierte Event-Planungs-Tool.
Beispiel api.php?call=events
Neuen Status setzen
Den neuen Status setzt Du mit &call=update_status&vorgang_nr=1234&status_id=6
Weitere optionale Parameter: km_stand_abfahrt - km_stand_ankunft als Integer. Der Kilometerstand wird anschließend direkt der Buchung mit hinzugefügt.
Mietvertrag abholen
Den Mietvertrag als PDF holst du ab mit: &call=contract&unique_id=buchungscode
Kundenliste
Die Kunden holst Du ab mit: &call=customerlist
bookyt ermöglicht es über die Onlinebuchung eine eigene, individuelle Zahlart zu aktivieren.
Im Backend unter Verwaltung -> Frontend -> Zahlarten, die individuelle Zahlart konfigurieren:
8. Buchungen auslesen
Beispiel api.php?call=get_bookings&date=24.12.2022
Die Rückgabe erfolgt in einem JSON-Array, das je nach Anzahl der hinterlegten Buchungen sehr groß werden kann.
Weitere Parameter
- date_stop - wenn ein Zeitraum angegeben werden soll
- station_id - Nur Buchungen die auf dieser Station beginnen, ausgeben
9. Zahlung verbuchen
Man kann einem Vorgang eine Zahlung zuordnen. Der Bezahlbetrag muss kleiner wie der noch offene Betrag sein, ansonsten wird der Call zurückgewiesen. Der Parameter &no=12323 entspricht der Vorgangsnummer.
Beispiel api.php?aktion=set_payment&no=XXX&amount=120.12
Wenn die Zahlung erfolgreich verbucht wurde, erhält man ein TRUE bzw. FALSE, falls die Buchung nicht erfolgreich war.
Als Zahlart wird die Zahlart aus dem Feld "Standard-Zahlart" in "Zahlungen-Schnellerfassung" in den globalen Einstellungen verwendet.
10. Events auslesen
Um im Eventplanungstool hinterlegte Veranstaltungen, die für das Internet freigeschaltet sind, auszulesen, nutzt man den Event-Call von bookyt. Als Rückgabe erhält man ein JSON Objekt mit dazugehöriger Kategorie, verknüpften Dateien und Artikel.
Voraussetzung ist das aktivierte Event-Planungs-Tool.
Beispiel api.php?call=events
Neuen Status setzen
Den neuen Status setzt Du mit &call=update_status&vorgang_nr=1234&status_id=6
Weitere optionale Parameter: km_stand_abfahrt - km_stand_ankunft als Integer. Der Kilometerstand wird anschließend direkt der Buchung mit hinzugefügt.
Mietvertrag abholen
Den Mietvertrag als PDF holst du ab mit: &call=contract&unique_id=buchungscode
Kundenliste
Die Kunden holst Du ab mit: &call=customerlist