Anbindung externer Systeme an die Autovermietungs- Software

Transkript

1 Dokumentation XML API Stand: 15. September 2012 PHCOM INFORMATIK Philipp Stäbler, Dipl. Wirtschaftsinf. (FH) Ulmer Str Stuttgart Tel: 0711 / Fax: 0711 / mail@phcom.de Anbindung externer Systeme an die Autovermietungs- Software Stand: 15. September 12 Mehr Informationen und Kontakt unter und software.com XML- Schnittstelle Allgemein Mit Hilfe der XML- Schnittstelle ist es möglich eigene Anwendungen an die webbasierte Autovermietungs- Software anzukoppeln. Bis auf die Anfrage zum Durchführen der Buchung (Aufruf per POST) werden alle Requests per GET an die Autovermietungs- Software gesendet. Strings werden von der Autovermietungs- Software base64enkodiert zurückgegeben. Jedem Request muß der Token in der Anfrage anhängen ansonsten wird die Anfrage zurückgewiesen. Standard- Frontend in der Mietversion Das Standardfrontend erreicht man immer mit dem Namen des Accounts vorgeschaltet vor der Subdomain. Der Account onlinedemo hat somit die URL: software.com 1

2 Verfügbarkeit ermitteln GET- Anfrage versenden: $URL = $Autovermietung_Application_URL."xml.php?aktion=CheckFree&start=".$datum_von."&sto p=".$datum_bis."&station_id={$station_id}&vermittler_id=".$vermittler_id."&token=".$toke n; Parameter Autovermietung_Application_URL datum_von und datum_bis station_id vermittler_id token anzahl_weiterer_fahrzeuge Beschreibung URL der Applikation, von PHCOM Unix Timestamp Werte der Anmietung ID der Station aus der AV- Software ID des Provisionsempfängers aus der AV- Software Erhalten Sie direkt von PHCOM Bei aktivierter Option in den Globalen Einstellungen, die Anzahl zusätzlicher Fahrzeuger zu dem Hauptfahrzeug Das Ergebnis ist ein Array mit Informationen zu allen verfügbaren Fahrzeuggruppen und den Tarifinfos. Strings werden von der Autovermietungs- Software base64enkodiert zurückgegeben. Rückgabe der Verfügbarkeitsanfrage Zurück erhält man ein Objekt, in dem die Verfügbarkeit für die einzelnen Fahrzeuggruppen und Fahrzeugsubgruppen sowie der Preis und weitere Informationen gelistet werden. Strings werden base64enkodiert zurückgegeben. In dem Rückgabeobjekt steht die "row" für eine Fahrzeuguntergruppe (Siehe dazu auch die Dokumentation der Autovermietungs- Software). Zusammenstellen der Daten und Versenden an den Autovermietungs- Software- SERVER Aus dem Rückgabeobjekt verwendet man eine Fahrzeugsubgruppe, die als verfügbar gekennzeichnet ist (verfuegbar=1 oder verfuegbar_bool=true) und stellte die Anfrage zusammen Temporäre Buchung durchführen Um eine Temporäre Buchung durchzuführen, muss an die AV-Software per POST folgender Befehl gesendet werden: $arraysend["misc"]["fzg_gruppe"] = fzg_gruppe_sub_id; $arraysend["misc"]["start"] = $if->start; //Unix Timestamp $arraysend["misc"]["stop"] = $if->stop; //Unix Timestamp 2

3 $arraysend["misc"]["station_id"] = station_id; $arraysend["misc"]["rueckgabeort_station_id"] = station_id; //Rückgabeort Als Aktion muß "maketempreservation" angegeben werden. Die Rückgabe ist analog "Buchung durchführen". Als Rückgabe erhält man in einem Array folgende Parameter: success: Erfolgreiche Buchung buchung_id: Die Buchung-ID vorgang_nr: Die temporäre Vorgangsnummer (Zu Debugzwecken) meldung: String-Meldung der Buchungsbestätigung. Die Temporäre Reservierung kann vom XML-Client wieder gelöscht werden. Wenn die Temporäre Reservierung nicht vom Frontend gelöscht wird, geschieht das automatisiert im Hintergrund. Alternativ dazu kann bei der Hauptbuchung die buchung_id der temporären Buchung mit dem Parameter $arraysend["temp_buchung_id"] übergeben werden - die temporäre Buchung wird dann vom System zu einer vollständigen Buchung konvertiert. Temporäre Buchung löschen Die Temporäre Buchung wird unter Angabe der BuchungID mit einem GET-Befehl gelöscht. Der Request-String setzt sich zusammen aus: buchung_id aktion: deletetempreservation z.b.: $URL=$Autovermietung_Application_URL."xml.php?aktion=deleteTem preservation&buchung_id=".$buchung_id."&token=".$token; Als Ergebnis wird der Erfolg der Aktion zurückgegeben. Stationen ermitteln Um die Stationsliste abzurufen verwenden Sie getstationen als Aktion. Das Antwortarray beinhaltet die Stations-ID und die dazugehörige Bezeichnung. Beispiel: xml.php?aktion=getstationen 3

4 Freitextfelder Vorgang Die im Internet verfügbaren Freitextfelder des Vorgangs werden mit der Aktion getfreitextfelder ermittelt. Die Rückgabe erfolgt in einem Array. Beispiel: xml.php?aktion=getfreitextfelder Freitextfelder Mieter Die im Internet verfügbaren Freitextfelder des Mieters werden mit der Aktion getfreitextfelderperson ermittelt. Die Rückgabe erfolgt in einem Array. Beispiel: xml.php?aktion=getfreitextfelderperson Freitextfelder Fahrer Die im Internet verfügbaren Freitextfelder des Fahrers werden mit der Aktion getfreitextfelderfahrer ermittelt. Die Rückgabe erfolgt in einem Array. Beispiel: xml.php?aktion=getfreitextfelderfahrer Frontend- Einstellungen Es können eigene Frontends an die Autovermietungs- Software angeschlossen werden. Wird das PHCOM- Frontend verwenden, werden mit dem Parameter loadsettings die Einstellungen für das Frontend ermittelt. In der Autovermietungs- Software werden die Einstellungen unter Systemparameter - Frontend- Einstellungen verwaltet. Beispiel: xml.php?aktion=loadsettings Als Rückgabe erhält man ein Objekt mit der Bezeichnung der Einstellung und dem dazugehörigen Wert. Login überprüfen Es ist möglich wiederkehrende Kunden zu identifizieren, mit dem Nachnamen und der Kundennummer. Parameter welche an die Autovermietungssoftware gesendet werden: aktion nachname kundennummer checklogin Der Nachname des Kunden, hinterlegt in der Autovermietungs-Software Die Kundennummer - erhält der Kunde für gewöhnlich in einer Buchungs- Bestätigungs- 4

5 Als Antwort erhält man auf den Request folgendes Array: login user_id rabatt name vorname firma kundennummer kundenkarte_nr fahrer true oder false. Bei true ist die Kombination gültig, bei false ungültig. Die Autovermietungs-Software-User-ID Standard-Rabatt des Kunden Der Nachname des Kunden Der Vorname des Kunden Hinterlegte Firma des Kunden Die Kundennummer Inhalt des Felds Kundenkarte aus der Personenverwaltung Die - Adresse des Kunden Die zugeordneten Fahrer für den Benutzer in einem Array 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. Wenn in den globalen Einstellungen der Parameter "Artikel auf Stationen eingrenzen verwenden" gesetzt ist, muss dem aufruf noch die Station mit "station_id=" übergeben werden. Beispiel: xml.php?aktion=getartikel AGBs ermitteln Um die aktuellen AGBs abzufragen verwendet man den Parameter aktion=getagb Beispiel: xml.php?aktion=getagb Länder Um die verfügbaren Länder abzufragen verwendet man den Parameter aktion=getlaender Beispiel: xml.php?aktion=getlaender 5

6 Führerscheinklassen Um die verfügbaren Führerscheinklassen abzufragen verwendet man den Parameter aktion=getfuehrerscheinklasse Beispiel: xml.php?aktion=getfuehrerscheinklasse Fahrzeuggruppen Die Fahrzeuggruppen ermitteln man dem Aufruf aktion=getfahrzeuggruppe Beispiel: xml.php?aktion=getfahrzeuggruppe Die Rückgabe erfolgt in einem Array mit folgenden Feldern: ID image_filename bezeichnung fzg_gruppe_sub fzg_gruppe_sub_bemerkung fzg_gruppe ID der Fahrzeuguntergruppe Dateiname der hinterlegten Vorschaugraphik Vollständige Bezeichnung der Fahrzeuggruppe Bezeichnung der Fahrzeuguntergruppe In der Fahrzeuggruppenverwaltung hinterlegte Bemerkung Bezeichnung der Fahrzeuggruppe Mehr Informationen zu den Fahrzeuggruppen findet man in der Dokumentation der Autovermietungs- Software. Buchung durchführen Array, was per POST an die AV- Software gesendet werden soll, zusammenstellen //Buchungsdaten $arraysend["misc"]["fzg_gruppe"] = fzg_gruppe_sub_id; $arraysend["misc"]["start"] = $if->start; //Unix Timestamp $arraysend["misc"]["stop"] = $if->stop; //Unix Timestamp $arraysend["misc"]["station_id"] = station_id; $arraysend["misc"]["rueckgabeort_station_id"] = station_id; //Rückgabeort $arraysend["misc"]["kilometer"] = $if->kilometer; $arraysend["misc"]["anzahl_gesamt_tage"] = $if- >anzahl_gesamt_tage; $arraysend["misc"]["preisliste_id"] = $if->preisliste_id; $arraysend["misc"]["standard_mwst_satz"] = 19; //19% MwSt $arraysend["misc"]["bemerkung_textarea"] = $if- 6

7 >bemerkung_textarea; $arraysend["misc"]["preisliste_betrag"] = $if- >preisliste_betrag; $arraysend["misc"]["preisliste_bezeichnung"] = $if- >preisliste_bezeichnung; $arraysend["misc"]["option_id"] = option_id; //Aus preisliste_optionen oder Leer $arraysend["misc"]["optionen_betrag"] = betrag; $arraysend["misc"]["zahlart_id"] = 2 /*Rechnung*/; $arraysend["misc"]["zahlbetrag"] = betrag; //Der Zahlbetrag für den Vorgang. $arraysend["misc"]["anzahl_weiterer_fahrzeuge"] = x; //Die Anzahl weiterer Fahrzeuge welche mit dieser Buchung zusätzlich zum Hauptfahrzeug gebucht werden //Personendaten if($kunde_id>0) { $kunde = new user($kunde_id); $arraysend["person"]["name"]=$kunde->user_data["name"]; $arraysend["person"]["vorname"]=$kunde- >user_data["vorname"]; $arraysend["person"]["firma"]=$kunde->user_data["firma"]; $arraysend["person"]["strasse"]=$kunde- >user_data["strasse"]; $arraysend["person"]["plz"]=$kunde->user_data["plz"]; $arraysend["person"]["ort"]=$kunde->user_data["ort"]; $arraysend["person"]["anrede_id"]=$kunde- >user_data["anrede_id"]; //ID der Anrede aus den Systemparametern - Anrede $arraysend["person"][" "]=$kunde->user_data[" "]; $arraysend["person"]["handy"]=$kunde- >user_data["handynr"]; $arraysend["person"]["telefon"]=$kunde- >user_data["telefon"]; $arraysend["person"]["geburtstag"]=$kunde- >user_data["geburtstag"]; } //Anfügen von Artikeln $arraysend["misc"]["artikel"][$artikel_id]["use"]=1; //Angabe das der Artikel verwendet werden soll $arraysend["misc"]["artikel"][$artikel_id]["anzahl"]=x; //X enstpricht der Anzahl des Artikels //Temporäre Buchung löschen (Optional) $arraysend["temp_buchung_id"] = 1235; 7

8 PHP- Beispiel Funktion um Daten per Post mit PHP versenden private function PostToHost($host, $path, $referer, $data_to_send) { $fp = fsockopen($host, 80); //printf("open!\n"); fputs($fp, "POST $path HTTP/1.1\r\n"); fputs($fp, "Host: $host\r\n"); fputs($fp, "Referer: $referer\r\n"); fputs($fp, "Content-type: application/x-www-formurlencoded\r\n"); fputs($fp, "Content-length: ". strlen($data_to_send)."\r\n"); fputs($fp, "Connection: close\r\n\r\n"); fputs($fp, $data_to_send); //printf("sent!\n"); while(!feof($fp)) { $res.= fgets($fp, 128); } //printf("done!\n"); fclose($fp); return $res; } function insertbuchung($array) { global $AppServer, $AppServerPath, $token; //Objekt serialisieren $tmpobj = serialize($array); $data = "v1=2&token=$token&aktion=makereservation&tmpobj=$tmpobj"; $x = $this->posttohost( $AppServer, "/$AppServerPath/xml.php", " $data); } $string = split("-----separator-----",$x); $obj = simplexml_load_string($string[1]); return $obj; Im Antwortarray befindet sich die AV- Software Vorgangsnummer mit der der Vorgang 8

9 identifiziert wird. 9