Alle API Calls aus der Buchungssoftware Tickyt und Travelmanager.

API-Dokumentation für die Datei xml_v1.php

Sicherheitsprüfungen

Der Zugriff auf die API wird durch Token-Überprüfungen geschützt. Es wird geprüft, ob der übergebene Token gültig ist und ob er in den globalen Einstellungen gespeichert ist. Nur bestimmte IP-Adressen dürfen möglicherweise Zugriff haben, was nicht weiter spezifiziert ist.

API Calls

Hintergrundbild abrufen

Endpoint: xml_v1.php?aktion=background_image
Beschreibung: Gibt die URL des Hintergrundbildes zurück. Falls das Bild nicht existiert, wird ein Standardbild zurückgegeben.
Parameter: Keine.

Buchungen für die iOS KundenApp abrufen

Endpoint: xml_v1.php?aktion=getBuchungen
Beschreibung: Ruft die Buchungen eines bestimmten Kunden ab.
Parameter:
- kundennummer (Pflicht, Integer): Die Kundennummer des Benutzers.
  - Beispiel: 12345
- email (Pflicht, String): Die E-Mail-Adresse des Benutzers.
  - Beispiel: kunde@example.com

Token-Validierung

Endpoint: xml_v1.php
Beschreibung: Überprüft die Gültigkeit des übergebenen Tokens. Bei ungültigem Token wird ein Fehler zurückgegeben.
Parameter:
- token (Pflicht, String): Der Token zur Authentifizierung.
  - Beispiel: HTQKT6Ev2OKC0378UBJAQ1t

Buchung stornieren

Endpoint: xml_v1.php?aktion=storno
Beschreibung: Storniert eine bestehende Buchung.
Parameter:
- reservierung_id (Pflicht, Integer): Die ID der Reservierung, die storniert werden soll.
  - Beispiel: 123

Zahlungstypen abrufen

Endpoint: xml_v1.php?aktion=getZahlarten
Beschreibung: Gibt eine Liste von verfügbaren Zahlungstypen zurück.
Parameter: Keine.

Gutscheinwert überprüfen

Endpoint: xml_v1.php?aktion=checkGutscheinValue
Beschreibung: Überprüft den Wert eines Gutscheincodes.
Parameter:
- gutscheincode (Pflicht, String): Der Gutschein-Code, der überprüft werden soll.
  - Beispiel: GUTSCHEIN2023
- reservierung_id (Optional, Integer): Die ID der Reservierung, die mit dem Gutschein verknüpft ist.
  - Beispiel: 456

Sitzplatz-Blockierung

Endpoint: xml_v1.php?aktion=blockSitzplatz
Beschreibung: Blockiert Sitzplätze für eine Buchung.
Parameter:
- tmp_key (Pflicht, String): Ein temporärer Schlüssel zur Identifizierung der Buchung.
  - Beispiel: abc123
- arrayPlaetze (Pflicht, String): Ein JSON-Array von Sitzplätzen, die blockiert werden sollen.
  - Beispiel: [1,2,3]

Sitzplatz-Entblockierung

Endpoint: xml_v1.php?aktion=unblockSitzplatz
Beschreibung: Hebt die Blockierung von Sitzplätzen auf.
Parameter:
- tmp_key (Pflicht, String): Der temporäre Schlüssel zur Identifizierung der Buchung.
  - Beispiel: abc123

Ressourcen abrufen

Endpoint: xml_v1.php?aktion=ressources
Beschreibung: Gibt eine Liste von verfügbaren Schiffen und deren Sitzplänen zurück.
Parameter:
- schiff_id (Optional, Integer): Die ID des Schiffs, um spezifische Ressourcen abzurufen.
  - Beispiel: 1

Verkehrstage abrufen

Endpoint: xml_v1.php?aktion=verkehrstage
Beschreibung: Gibt die Verkehrstage für eine bestimmte Linie zurück.
Parameter:
- linie_id (Pflicht, Integer): Die ID der Linie, für die die Verkehrstage abgerufen werden sollen.
  - Beispiel: 1

Buchungen senden

Endpoint: xml_v1.php?aktion=buchungen_senden
Beschreibung: Sendet Buchungen von einer mobilen App.
Parameter:
- data (Pflicht, JSON): Die Buchungsdaten als JSON-String.
  - Beispiel: {"buchungscode":"123456","personen":[{"typ":"preistyp","ds_id":1,"anzahl":2}]}

Artikel abrufen

Endpoint: xml_v1.php?aktion=getArtikel
Beschreibung: Gibt eine Liste von Artikeln zurück, die für Buchungen verfügbar sind.
Parameter:
- kategorie_id (Optional, Integer): Die ID der Kategorie, um Artikel aus einer bestimmten Kategorie abzurufen.
  - Beispiel: 2
- online (Optional, String): Gibt an, ob nur Online-Artikel abgerufen werden sollen.
  - Beispiel: true

Gutschein einlösen

Endpoint: xml_v1.php?aktion=insertGutscheinTransaction
Beschreibung: Löst einen Gutschein ein und gibt den verbleibenden Betrag zurück.
Parameter:
- code (Pflicht, String): Der Gutschein-Code, der eingelöst werden soll.
  - Beispiel: GUTSCHEIN2023
- betrag (Pflicht, Float): Der Betrag, der vom Gutschein abgebucht werden soll.
  - Beispiel: 50.00
- bemerkung (Optional, String): Eine optionale Bemerkung zur Transaktion.
  - Beispiel: Einlösung für Ticketkauf

Gutscheincode abrufen

Endpoint: xml_v1.php?aktion=getGutschein
Beschreibung: Gibt Informationen über einen Gutschein zurück.
Parameter:
- code (Pflicht, String): Der Gutscheincode, für den Informationen abgerufen werden sollen.
  - Beispiel: GUTSCHEIN2023

Weitere API-Calls

Zusätzlich gibt es noch weitere API-Calls, die jedoch nicht dokumentiert werden, da sie in der Liste der Ausnahmen genannt sind.

Bitte beachten Sie, dass die hier aufgeführten API-Calls aus der Datei xml_v1.php stammen und alle anderen in den Ausnahmen genannten Calls nicht dokumentiert sind.

API-Dokumentation für run_fahrplan_ausgabe.php

Sicherheitsprüfungen

Der Zugriff auf die API ist durch IP-Checks geschützt. Nur bestimmte IP-Adressen sind für den Zugriff freigeschaltet. Es wird empfohlen, diese IP-Adressen zu überprüfen, um unbefugten Zugriff zu verhindern.

API Calls

Call für den Eventkalender

Endpoint: run_fahrplan_ausgabe.php?aktion=eventcalendar
Beschreibung: Dieser Call gibt einen Kalender mit den Eventfahrten zurück. Der Kalender wird für einen bestimmten Linientyp und ein Datum erzeugt.
Parameter:
- linie_typ_id
  - Datentyp: String
  - Mögliche Werte: IDs der Linientypen, die angezeigt werden sollen.
  - Beispiel: linie_typ_id=1,2,3
- datum
  - Datentyp: String
  - Mögliche Werte: Ein Datum im deutschen Format (z.B. 01.01.2023).
  - Beispiel: datum=01.01.2023
- extra_months
  - Datentyp: Integer
  - Mögliche Werte: Positive oder negative Ganzzahlen, um Monate hinzuzufügen oder abzuziehen.
  - Beispiel: extra_months=1
- use_category_id
  - Datentyp: String
  - Mögliche Werte: IDs der Kategorien, die verwendet werden sollen.
  - Beispiel: use_category_id=1,2
- use_station_id
  - Datentyp: Integer
  - Mögliche Werte: ID der verwendeten Station.
  - Beispiel: use_station_id=5
- newwindow
  - Datentyp: Boolean
  - Mögliche Werte: true oder false, ob der Kalender in einem neuen Fenster geöffnet werden soll.
  - Beispiel: newwindow=true
- godirect
  - Datentyp: Boolean
  - Mögliche Werte: true oder false, ob direkt zur Buchung weitergeleitet werden soll.
  - Beispiel: godirect=false

Call für die Fahrtsuche

Endpoint: run_fahrplan_ausgabe.php?aktion=fahrtsuche
Beschreibung: Dieser Call sucht nach verfügbaren Fahrten basierend auf den angegebenen Kriterien und gibt eine Liste der Fahrten zurück.
Parameter:
- station_id
  - Datentyp: Integer
  - Mögliche Werte: ID der Station, nach der gesucht wird.
  - Beispiel: station_id=1
- start
  - Datentyp: String
  - Mögliche Werte: Ein Datum im deutschen Format (z.B. 01.01.2023).
  - Beispiel: start=01.01.2023
- zeitraum
  - Datentyp: Integer
  - Mögliche Werte: Anzahl der Tage, für die die Fahrten gesucht werden.
  - Beispiel: zeitraum=30
- linientyp_id
  - Datentyp: Integer
  - Mögliche Werte: ID des Linientyps, nach dem gesucht wird.
  - Beispiel: linientyp_id=2

Call für die Listenkategorien

Endpoint: run_fahrplan_ausgabe.php?aktion=listcategories
Beschreibung: Dieser Call gibt eine Liste der verfügbaren Kategorien zurück, die für die Fahrten verwendet werden können.
Parameter:
- start
  - Datentyp: Integer
  - Mögliche Werte: Unix-Timestamp, um den Startzeitpunkt für die Anfrage festzulegen.
  - Beispiel: start=1672531200
- max
  - Datentyp: Integer
  - Mögliche Werte: Anzahl der maximalen Einträge, die zurückgegeben werden sollen.
  - Beispiel: max=5
- station_id
  - Datentyp: Integer
  - Mögliche Werte: ID der Station, für die die Kategorien abgerufen werden.
  - Beispiel: station_id=1

Call für die Suche nach Verkehrstagen

Endpoint: run_fahrplan_ausgabe.php?aktion=verkehrstage
Beschreibung: Dieser Call gibt die Verkehrstage für die angegebene Linie und den angegebenen Zeitraum zurück.
Parameter:
- hafen_id
  - Datentyp: Integer
  - Mögliche Werte: ID des Hafens, für den die Verkehrstage abgerufen werden.
  - Beispiel: hafen_id=3
- start_datum
  - Datentyp: String
  - Mögliche Werte: Startdatum im deutschen Format (z.B. 01.01.2023).
  - Beispiel: start_datum=01.01.2023
- stop_datum
  - Datentyp: String
  - Mögliche Werte: Enddatum im deutschen Format (z.B. 31.01.2023).
  - Beispiel: stop_datum=31.01.2023
- linien_ids
  - Datentyp: String
  - Mögliche Werte: IDs der Linien, für die die Verkehrstage abgerufen werden.
  - Beispiel: linien_ids=1,2,3

Call für die Suche nach Fahrplänen

Endpoint: run_fahrplan_ausgabe.php?aktion=finden
Beschreibung: Dieser Call sucht nach Fahrplänen basierend auf den angegebenen Kriterien und gibt die Ergebnisse zurück.
Parameter:
- linien_ids
  - Datentyp: String
  - Mögliche Werte: IDs der Linien, nach denen gesucht wird.
  - Beispiel: linien_ids=1,2
- linie_typ_id
  - Datentyp: Integer
  - Mögliche Werte: ID des Linientyps, nach dem gesucht wird.
  - Beispiel: linie_typ_id=1
- start_datum
  - Datentyp: String
  - Mögliche Werte: Startdatum im deutschen Format (z.B. 01.01.2023).
  - Beispiel: start_datum=01.01.2023
- modus
  - Datentyp: String
  - Mögliche Werte: Modus für die Ausgabe (z.B. liste_alternativ).
  - Beispiel: modus=liste_alternativ

Hinweis

Die oben genannten API-Calls sind alle, die nicht in der Liste der auszuschließenden Calls enthalten sind. Bitte stellen Sie sicher, dass die Parameter korrekt übergeben werden, um die gewünschten Ergebnisse zu erhalten.

Hier ist die Dokumentation der API-Calls aus der Datei xml_v2.php, die den angegebenen Kriterien entspricht. Die nicht zu dokumentierenden Calls wurden ignoriert.

Sicherheitsprüfungen

Der Zugriff auf die API wird durch Token-Überprüfungen geschützt. Es wird geprüft, ob ein gültiger Token in den GET- oder POST-Anfragen vorhanden ist. Es gibt möglicherweise Einschränkungen, sodass nur bestimmte IP-Adressen Zugriff haben.

API-Dokumentation

Abfrage von Chartertypen

Endpoint: /xml_v2.php?call=purp
Beschreibung: Dieser Call gibt eine Liste von Chartertypen zurück, die in der Datenbank gespeichert sind.
Parameter:
- Namen: keine zusätzlichen Parameter erforderlich.
- Erwarteter Datentyp: keine.
- Mögliche Werte: keine.
- Beispiel: /xml_v2.php?call=purp

Abfrage von Standorten

Endpoint: /xml_v2.php?call=locations
Beschreibung: Dieser Call liefert eine Liste von Standorten mit zusätzlichen Informationen wie Region und Betreiber-IDs.
Parameter:
- Namen: keine zusätzlichen Parameter erforderlich.
- Erwarteter Datentyp: keine.
- Mögliche Werte: keine.
- Beispiel: /xml_v2.php?call=locations

Abfrage von Ressourcen

Endpoint: /xml_v2.php?call=ressources
Beschreibung: Dieser Call gibt eine Liste von Ressourcen (Schiffen) zurück, die in der Datenbank gespeichert sind.
Parameter:
- Namen: keine zusätzlichen Parameter erforderlich.
- Erwarteter Datentyp: keine.
- Mögliche Werte: keine.
- Beispiel: /xml_v2.php?call=ressources

Reservierung eines Platzes

Endpoint: /xml_v2.php?call=place
Beschreibung: Dieser Call speichert eine neue Reservierung basierend auf den angegebenen Parametern.
Parameter:
- Namen:
  - typ_id (Pflichtparameter, Integer): ID des Reservierungstyps.
  - remarks (Optional, String): Zusätzliche Bemerkungen zur Reservierung.
  - station_id (Pflichtparameter, Integer): ID der Station.
  - ressource_id (Pflichtparameter, Integer): ID der Ressource (Schiff).
  - start (Pflichtparameter, String): Startdatum der Reservierung.
  - stop (Pflichtparameter, String): Enddatum der Reservierung.
- Beispiel: /xml_v2.php?call=place&typ_id=1&remarks=Test&station_id=2&ressource_id=3&start=2023-04-01&stop=2023-04-02

Überprüfung eines Artikels

Endpoint: /xml_v2.php?call=checkItem
Beschreibung: Dieser Call überprüft die Gültigkeit eines Artikels anhand eines Barcodes und entwertet ihn, falls gültig.
Parameter:
- Namen:
  - barcode (Pflichtparameter, String): Der Barcode des Artikels.
  - user_id (Pflichtparameter, Integer): ID des Benutzers, der die Überprüfung durchführt.
- Beispiel: /xml_v2.php?call=checkItem&barcode=1234567890123&user_id=1

Stornierung einer Reservierung

Endpoint: /xml_v2.php?call=cancel
Beschreibung: Dieser Call storniert eine bestehende Reservierung basierend auf der Vorgangsnummer.
Parameter:
- Namen:
  - vorgang_nr (Pflichtparameter, Integer): Die Vorgangsnummer der Reservierung.
  - remarks (Optional, String): Zusätzliche Bemerkungen zur Stornierung.
- Beispiel: /xml_v2.php?call=cancel&vorgang_nr=123&remarks=Stornierung

Abfrage von Preisarten

Endpoint: /xml_v2.php?call=getPriceTypes
Beschreibung: Dieser Call gibt die verschiedenen Preisarten zurück, die in den globalen Einstellungen definiert sind.
Parameter:
- Namen: keine zusätzlichen Parameter erforderlich.
- Erwarteter Datentyp: keine.
- Mögliche Werte: keine.
- Beispiel: /xml_v2.php?call=getPriceTypes

Abfrage von Produkt-Keys

Endpoint: /xml_v2.php?call=getProductKeys
Beschreibung: Dieser Call gibt eine Liste von Produkt-Keys für den angegebenen Benutzer zurück.
Parameter:
- Namen:
  - portal (Pflichtparameter, Integer): ID des Portals.
- Beispiel: /xml_v2.php?call=getProductKeys&portal=1

Abfrage von Bewertungen

Endpoint: /xml_v2.php?call=ratings
Beschreibung: Dieser Call gibt die Bewertungen für eine bestimmte Linie zurück.
Parameter:
- Namen:
  - linie_id (Pflichtparameter, Integer): ID der Linie, für die die Bewertungen abgefragt werden.
- Beispiel: /xml_v2.php?call=ratings&linie_id=1

Diese Dokumentation listet die relevanten API-Calls auf, die in der Datei xml_v2.php definiert sind, und gibt einen Überblick über deren Funktionalitäten und Anforderungen.

API-Dokumentation für run_channelmanager_result.php

Sicherheitsprüfungen

Der Zugriff auf die API ist durch die Verwendung eines Tokens geschützt. Der Token wird über die GET- oder POST-Parameter token bereitgestellt und muss mit dem in den globalen Einstellungen definierten portal_token übereinstimmen. Es gibt möglicherweise auch Einschränkungen, sodass nur bestimmte IP-Adressen Zugriff haben.

API-Calls

Fetch Stations

Endpoint: run_channelmanager_result.php?call=fetchstations&portal={portal}&token={token}
Beschreibung: Dieser Call ruft eine Liste von verfügbaren Stationen ab, die in der Datenbank gespeichert sind.
Parameter:
- portal
  - Typ: Integer
  - Mögliche Werte: Kundennummer, die im System existiert.
  - Beispiel: 71

Relations

Endpoint: run_channelmanager_result.php?call=relations&portal={portal}&station_id={station_id}&date={date}&token={token}
Beschreibung: Dieser Call gibt die Fahrpläne und Verbindungen für eine bestimmte Station an einem bestimmten Datum zurück.
Parameter:
- portal
  - Typ: Integer
  - Mögliche Werte: Kundennummer, die im System existiert.
  - Beispiel: 71
- station_id
  - Typ: Integer
  - Mögliche Werte: ID einer Station, die im System existiert.
  - Beispiel: 1001
- date
  - Typ: String
  - Mögliche Werte: Ein Datum im Format YYYY-MM-DD.
  - Beispiel: 2023-10-01

Availability

Endpoint: run_channelmanager_result.php?call=availability&portal={portal}&product={product}&start={start}&stop={stop}&token={token}
Beschreibung: Dieser Call prüft die Verfügbarkeit von Fahrten für ein bestimmtes Produkt innerhalb eines gegebenen Datumsbereichs.
Parameter:
- portal
  - Typ: Integer
  - Mögliche Werte: Kundennummer, die im System existiert.
  - Beispiel: 71
- product
  - Typ: String
  - Mögliche Werte: Produkt-ID, die im System existiert.
  - Beispiel: product_123
- start
  - Typ: String
  - Mögliche Werte: Startdatum im Format YYYY-MM-DD HH:MM:SS.
  - Beispiel: 2023-10-01 00:00:00
- stop
  - Typ: String
  - Mögliche Werte: Enddatum im Format YYYY-MM-DD HH:MM:SS.
  - Beispiel: 2023-10-31 23:59:59

Cancel

Endpoint: run_channelmanager_result.php?call=cancel&portal={portal}&booking_reference={booking_reference}&token={token}
Beschreibung: Dieser Call storniert eine bestehende Buchung basierend auf der Buchungsreferenz.
Parameter:
- portal
  - Typ: Integer
  - Mögliche Werte: Kundennummer, die im System existiert.
  - Beispiel: 71
- booking_reference
  - Typ: Integer
  - Mögliche Werte: Buchungsreferenz, die im System existiert.
  - Beispiel: 12345

Booking

Endpoint: run_channelmanager_result.php?call=booking&portal={portal}&token={token}
Beschreibung: Dieser Call führt eine Buchung durch, basierend auf den übergebenen Ticketinformationen.
Parameter:
- portal
  - Typ: Integer
  - Mögliche Werte: Kundennummer, die im System existiert.
  - Beispiel: 71
- product
  - Typ: String
  - Mögliche Werte: Produkt-ID, die im System existiert.
  - Beispiel: product_123
- ticket
  - Typ: Array
  - Mögliche Werte: Array von Ticket-Objekten, jedes mit id, quantity, remarks, etc.
  - Beispiel: [{"id":1,"quantity":2,"remarks":"VIP Ticket"}]
- date
  - Typ: String
  - Mögliche Werte: Abfahrtsdatum im Format YYYY-MM-DD.
  - Beispiel: 2023-10-01
- product_return
  - Typ: String (optional)
  - Mögliche Werte: Produkt-ID für Rückfahrt.
  - Beispiel: product_return_123

Diese API-Dokumentation beschreibt die verfügbaren API-Calls in der Datei run_channelmanager_result.php, die über GET- oder POST-Anfragen aufgerufen werden können.