API

Mit der API verknüpfen Sie Ihre eigene Anwendungen an die webbasierte Vermietsoftware. Allen Aufrufen muss der Parameter &token=xyz beigefügt werden. Den Token legen Sie im Backend der Vermietsoftware unter Einstellungen – API fest. Die Rückgabe erfolgt im JSON Format.Artikel

Verfügbare Artikel ermitteln

Um die für das Internet verfügbare Artikelliste abzurufen verwenden Sie getArtikel als Aktion. Das Antwortarray beinhaltet die Artikel-ID und die dazugehörige Bezeichnung.

Beispiel: api.php?call=articlesAGB

AGBs ermitteln

Um die aktuellen AGBs abzufragen verwendet man den Parameter call=tac

Beispiel: api.php?call=tacRessourcen

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 und dann im Detaileintrag der Gruppe
  • station_id – die ID einer Station, zu finden unter Verwaltung – Stationen

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 finden Sie im Backend unter Verwaltung – Fahrzeuge:

  • fahrzeug_id – die ID des Fahrzeugs

Stationen ermitteln

Call um die aktiven im Internet veröffentlichten Stationen zu erhalten. Ersetzen Sie bei dem u.a. Call Ihren Token

Beispiel: api.php?call=locations&token=xyzGruppen 

Fügen Sie den Parameter &show=all hinzu, um auch inaktive und nicht für die Onlinebuchung freigegebene Stationen mit auszugeben.

Gruppen und Kategorien

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

Mehr Informationen zu den Gruppen finden Sie auch in der Dokumentation

Vorgangsinformationen ermitteln

Informationen zu einem Vorgang ermittelt man mit diesem Aufruf

Beispiel: api.php?call=get_booking&no=XXX&token=xyz

Der Parameter no kann entweder die Vorgangsnummer oder 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 Rechnungsnnummer. Wenn diese 0 ist, wurde sie noch nicht vergeben
mietbeginn_datum Datum der Anmietung
gesamtbetrag_brutto Bruttobetrag
mwst_satz MwSt-Satz des Vorgangs
gesamtbetrag_netto Netto-Gesamtbetrag
offen_betrag Höhe des offenen Betrags
Positionen:
value: Einzelbetrag
bezeichnung: Postionen-Bezeichnung
anzahl: Anzahl (Menge)
Alle Positionen des Vorgangs

Individuelle Zahlart

Die Vermietsoftware avs.rent ermöglicht es über die Onlinebuchung eine eigene, individuelle Zahlart zu aktivieren. Der Ablauf hierzu ist folgender:

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

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 kannZahlung verbuchen

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 wenn der Ausführung nicht erfolgreich war.

Als Zahlart wird die Zahlart aus dem Feld „Standard-Zahlart in ‚Zahlungen-Schnellerfassung'“ in den Globalen Einstellungen verwendetEvents

Events auslesen

Um im Eventplanungstool hinterlegte Veranstaltungen, die für das Internet freigeschaltet sind, auszulesen, nutzt man den Event-Call der AVS. Als Rückgabe erhält man ein JSON Objekt mit dazugehörigen Kategorie, verknüpfte Dateien und Artikel

Voraussetzung ist das aktivierte Event-Planungs-Tool.

Beispiel: api.php?call=events