Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- dokumentation_der_soap_schnittstelle_1.0 [2015-12-03 21:58]
Christian
+++ dokumentation_der_soap_schnittstelle_1.0 [2018-11-07 17:57] (aktuell)
admin Formatierung
@@ Zeile 1: / Zeile 1: @@
+====== Dokumentation der SOAP Schnittstelle 1.0 ======
 **Bitte beachten Sie, dass die SOAP-APIs nicht mehr aktiv weiterentwickelt werden. Neue Kunden sollten ausschließlich die RESTful API nutzen, bestehende Nutzer der SOAP-Schnittstellen sollten mittelfristig auf REST umstellen.**
@@ Zeile 6: / Zeile 8: @@
-====== SOAP-Zugang ======
+===== SOAP-Zugang =====
-===== Zugangsdaten =====
-  *  Proxy/SOAP-Server:
- http://www.autofokus24.de/SoapServer.php
-  *  WSDL-Datei:
+==== Zugangsdaten ====
- http://www.autofokus24.de/SoapServer.php?wsdl
-  oder
-  http://www.autofokus24.de/afsoap.wsdl
-  *  Encoding:
- ISO-8859-1
-  *  Namespace/URN:
+  *  Proxy/SOAP-Server: ''http://www.autofokus24.de/SoapServer.php''
- autofokus24
+  *  WSDL-Datei: ''http://www.autofokus24.de/SoapServer.php?wsdl'' oder ''http://www.autofokus24.de/afsoap.wsdl''
+  *  Encoding: ''ISO-8859-1''
+  *  Namespace/URN: ''autofokus24''
-====== Funktionen ======
+===== Funktionen =====
-===== login =====
+==== login ====
-Syntax: <code>bool login ( string username, string password [ ,bool useSoapFaults = false] )</code>
+Syntax: ''bool login ( string username, string password [ ,bool useSoapFaults = false] )''
 Mit dieser Funktion loggen Sie sich mit Ihrem Nutzernamen/Passwort im System ein. Der Login wird serverseitig in einer Session gehalten, dafür ist es aber notwendig, dass Sie clientseitig das Setzen von Cookies ermöglichen. Sollte dies nicht möglich sein, kann bei jedem anderen Funktionsaufruf der Nutzername und das Passwort als letzter optionaler Parameter übergeben werden.
-  *  Parameter
+  * Parameter
- username: Ihr Nutzername
+    * username: Ihr Nutzername
- password: Ihr Passwort
+    * password: Ihr Passwort
-  *  Rückgabewert
+  * Rückgabewert
- Liefert true im erfolgsfall zurück. Liefert false im Fehlerfall zurück. Sollte die Ausnahmebehandlung aktiviert sein (useSoapFaults=true) wird ein Fehler (Exception) geworfen.
+    * Liefert true im erfolgsfall zurück. Liefert false im Fehlerfall zurück. Sollte die Ausnahmebehandlung aktiviert sein (useSoapFaults=true) wird ein Fehler (Exception) geworfen.
-===== calcCar =====
+==== calcCar ====
-Syntax: <code>array calcCar(string hsn, string tsn, int year, int month, int miles [,string fuzzyText = "" [,string specialModel = "" [,string featureList = "" [,string color = "" [,int power = 0 [,int fuel = 0 [,int buildType = 0 [,int doorCount = 0 [,string username = "" [,string password = "" ]]]]]]]]]] ) </code>
+Syntax: ''array calcCar(string hsn, string tsn, int year, int month, int miles [,string fuzzyText = "" [,string specialModel = "" [,string featureList = "" [,string color = "" [,int power = 0 [,int fuel = 0 [,int buildType = 0 [,int doorCount = 0 [,string username = "" [,string password = "" ]]]]]]]]]] ) ''
 Diese Funktion liefert Ihnen ein Array mit den Daten des erkannten Fahrzeuges, sowie den berechneten Verkaufspreis (price) und den Händlereinkaufspreis (priceEK). Wenn die übergebenen Parameter nicht eindeutig auf ein bestimmtes Fahrzeug verweisen (häufig der Fall bei fehlender Angabe des Sondermodells (specialModel) oder bei exotischen Fahrzeugen), wird eine Liste aus mehreren Arrays zurückgegeben. Für jedes Ergebnis werden dabei weiterhin die Preise berechnet. Sie können dann programmseitig filtern, oder die Parameter entsprechend einschränken.
-  *  Parameter
+  * Parameter
- hsn: Die 4-stellige Herstellerschlüsselnummer gemäß Kraftfahrzeugbundesamt.
+    * hsn: Die 4-stellige Herstellerschlüsselnummer gemäß Kraftfahrzeugbundesamt.
- tsn: Die 3-stellige Herstellerschlüsselnummer gemäß Kraftfahrzeugbundesamt.
+    * tsn: Die 3-stellige Herstellerschlüsselnummer gemäß Kraftfahrzeugbundesamt.
- year: Das Jahr der Erstzulassung.
+    * year: Das Jahr der Erstzulassung.
- month: Der Monat der Erstzulassung.
+    * month: Der Monat der Erstzulassung.
- miles: Laufleistung in Kilometern
+    * miles: Laufleistung in Kilometern
- fuzzyText (optional): Hier kann der Freitext übergeben werden, mit dessen Hilfe die interne künstliche Intelligenz die Ausstattungen, Extras, Farbe, Sondermodell usw. erkannt wird. Als Freitext eignet sich beispielsweise die Inseratsbeschreibung inkl. Titel eines angebotenen Fahrzeuges.
+    * fuzzyText (optional): Hier kann der Freitext übergeben werden, mit dessen Hilfe die interne künstliche Intelligenz die Ausstattungen, Extras, Farbe, Sondermodell usw. erkannt wird. Als Freitext eignet sich beispielsweise die Inseratsbeschreibung inkl. Titel eines angebotenen Fahrzeuges.
- specialModel (optional): Der Name eines bestimmten Sondermodells (z.B.: "Elegance" oder "Highline"...)
+    * specialModel (optional): Der Name eines bestimmten Sondermodells (z.B.: "Elegance" oder "Highline"...)
- featureList (optional): Eine Kommaseparierte Liste an Kürzel/Shortcuts von expliziten Extras oder Ausstattungsmerkmalen (z.B.: "KLI,AIB,NAV,PDC") Die Funktion getFeatureList(...) liefert Ihnen eine Liste an möglichen Extras und deren Kürzel/Shortcuts.
+    * featureList (optional): Eine Kommaseparierte Liste an Kürzel/Shortcuts von expliziten Extras oder Ausstattungsmerkmalen (z.B.: "KLI,AIB,NAV,PDC") Die Funktion getFeatureList(...) liefert Ihnen eine Liste an möglichen Extras und deren Kürzel/Shortcuts.
- color (optional): Das Kürzel/Shortcut der Farbe des Fahrzeuges. (z.B.: "RED") Die Funktion getColors(...) liefert Ihnen eine Liste an möglichen Farben und deren Kürzel/Shortcuts.
+    * color (optional): Das Kürzel/Shortcut der Farbe des Fahrzeuges. (z.B.: "RED") Die Funktion getColors(...) liefert Ihnen eine Liste an möglichen Farben und deren Kürzel/Shortcuts.
- power (optional): Die Motorleistung des Fahrzeuges in Kilowatt.
+    * power (optional): Die Motorleistung des Fahrzeuges in Kilowatt.
- fuel (optional): Die Motorart des Fahrzeuges (1 = Ottomotor, 2 = Dieselmotor, 3 = Wankelmotor, 4 = Benzin-Elektro-Hybrid).
+    * fuel (optional): Die Motorart des Fahrzeuges (1 = Ottomotor, 2 = Dieselmotor, 3 = Wankelmotor, 4 = Benzin-Elektro-Hybrid).
- buildType (optional): Die Aufbauvariante des Fahrzeuges (1 = Limousine, 2 = Kombi/Van, 3 = Coupe, 4 = Cabrio).
+    * buildType (optional): Die Aufbauvariante des Fahrzeuges (1 = Limousine, 2 = Kombi/Van, 3 = Coupe, 4 = Cabrio).
- doorCount (optional): Anzahl der Türen.
+    * doorCount (optional): Anzahl der Türen.
- username (optional): Ihr Nutzername, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert.
+    * username (optional): Ihr Nutzername, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert.
- password (optional): Ihr Passwort, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert.
+    * password (optional): Ihr Passwort, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert.
-  *  Rückgabewert
+  * Rückgabewert
- Liefert im Erfolgsfall ein Array oder eine Liste an Arrays zurück mit den genauen Daten des erkannten Fahrzeuges und die geschätzten Fahrzeugpreise. Dabei ist "price" der Verkaufspreis und "priceEK" der Händlereinkaufspreis. Alle weiteren Daten erklären sich quasi von selbst. Wenn kein Fahrzeug erkannt wird, wird ein leeres Array zurückgegeben.
+    * Liefert im Erfolgsfall ein Array oder eine Liste an Arrays zurück mit den genauen Daten des erkannten Fahrzeuges und die geschätzten Fahrzeugpreise. Dabei ist "price" der Verkaufspreis und "priceEK" der Händlereinkaufspreis. Alle weiteren Daten erklären sich quasi von selbst. Wenn kein Fahrzeug erkannt wird, wird ein leeres Array zurückgegeben.
+    * Für die erkannten Ausstattungsmerkmale gibt es zusätzlich eine Reihe von Rückgabewerten:
+      * extrasByDate: Sind die Ausstattungsmerkmale welche das Fahrzeug anhand seiner Grundausstattung und Bauzeit hat (Analog der Darstellung auf der Autofokus24-Website "Grundausstattung nach Bauzeit").
+      * extrasByMotor: Sind die zusätzlichen Ausstattungsmerkmale welche das Fahrzeug aufgrund seiner Motorisierung hat (Analog der Darstellung auf der Autofokus24-Website "Zusatzausstattung durch Motorisierung").
+      * extrasBySpecialModel: Sind die zusätzlichen Ausstattungsmerkmale welche das Fahrzeug aufgrund seines Sondermodells hat (Analog der Darstellung auf der Autofokus24-Website "Zusatzausstattung durch Sondermodell").
+      * extras (veraltet!): Ist die Summe/Vereinigung der Ausstattungen extrasByDate, extrasByMotor, extrasBySpecialModel. Der einzige Unterschied ist, dass hierbei die Unterteilung in (extrasByDate, extrasByMotor, extrasBySpecialModel) fehlt. Aus Kompatibilitätsgründen wird dieser Wert weiterhin zurückgeliefert, sollte aber nicht mehr verwendet werden. Verwenden Sie stattdessen die drei Rückgabewerte extrasByDate, extrasByMotor, extrasBySpecialModel.
+      * significantExtras: Sind die möglichen weiteren Ausstattungsmerkmale welche sich gemäß der Autofokus24-Schätzung statistisch relevant auf den Fahrzeugwert auswirken (Analog der Darstellung auf der Autofokus24-Website "Weitere Ausstattung").
- Für die erkannten Ausstattungsmerkmale gibt es zusätzlich eine Reihe von Rückgabewerten:
- extrasByDate: Sind die Ausstattungsmerkmale welche das Fahrzeug anhand seiner Grundausstattung und Bauzeit hat (Analog der Darstellung auf der Autofokus24-Website "Grundausstattung nach Bauzeit").
+==== getFeatureList ====
- extrasByMotor: Sind die zusätzlichen Ausstattungsmerkmale welche das Fahrzeug aufgrund seiner Motorisierung hat (Analog der Darstellung auf der Autofokus24-Website "Zusatzausstattung durch Motorisierung").
- extrasBySpecialModel: Sind die zusätzlichen Ausstattungsmerkmale welche das Fahrzeug aufgrund seines Sondermodells hat (Analog der Darstellung auf der Autofokus24-Website "Zusatzausstattung durch Sondermodell").
- extras (veraltet!): Ist die Summe/Vereinigung der Ausstattungen extrasByDate, extrasByMotor, extrasBySpecialModel. Der einzige Unterschied ist, dass hierbei die Unterteilung in (extrasByDate, extrasByMotor, extrasBySpecialModel) fehlt. Aus Kompatibilitätsgründen wird dieser Wert weiterhin zurückgeliefert, sollte aber nicht mehr verwendet werden. Verwenden Sie stattdessen die drei Rückgabewerte extrasByDate, extrasByMotor, extrasBySpecialModel.
- significantExtras: Sind die möglichen weiteren Ausstattungsmerkmale welche sich gemäß der Autofokus24-Schätzung statistisch relevant auf den Fahrzeugwert auswirken (Analog der Darstellung auf der Autofokus24-Website "Weitere Ausstattung").
+Syntax: ''array getFeatureList ([username = "", password = ""])''
-===== getFeatureList =====
+Diese Funktion liefert Ihnen ein Array der möglichen Ausstattungen/Extras und dessen Kürzel/Shortcuts, welche bei der Funktion calcCar(...) explizit übergeben werden können.
-Syntax: <code>array getFeatureList ([username = "", password = ""])</code>
+  * Parameter
+    * username (optional): Ihr Nutzername, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert.
+    * password (optional): Ihr Passwort, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert.
+  * Rückgabewert
+    * Liefert ein Array mit den möglichen Ausstattungen/Extras und dessen Kürzel/Shortcuts zurück. Im Fehlerfall wird ein leeres Array zurückgegeben. Sollte die Ausnahmebehandlung aktiviert sein (useSoapFaults=true) wird ein Fehler (Execption) geworfen.
-Diese Funktion liefert Ihnen ein Array der möglichen Ausstattungen/Extras und dessen Kürzel/Shortcuts, welche bei der Funktion calcCar(...) explizit übergeben werden können.
-  *  Parameter
+==== getColors ====
- username (optional): Ihr Nutzername, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert.
- password (optional): Ihr Passwort, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert.
-  *  Rückgabewert
- Liefert ein Array mit den möglichen Ausstattungen/Extras und dessen Kürzel/Shortcuts zurück. Im Fehlerfall wird ein leeres Array zurückgegeben. Sollte die Ausnahmebehandlung aktiviert sein (useSoapFaults=true) wird ein Fehler (Execption) geworfen.
+Syntax: ''array getColors ([username = "", password = ""]) ''
-===== getColors =====
+Diese Funktion liefert Ihnen ein Array der möglichen Farben und dessen Kürzel/Shortcuts, welche bei der Funktion calcCar(...) explizit übergeben werden können.
-Syntax: <code>array getColors ([username = "", password = ""]) </code>
+  * Parameter
+    * username (optional): Ihr Nutzername, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert.
+    * password (optional): Ihr Passwort, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert.
+  * Rückgabewert
+    * Liefert ein Array mit den möglichen Farben und dessen Kürzel/Shortcuts zurück. Im Fehlerfall wird ein leeres Array zurückgegeben. Sollte die Ausnahmebehandlung aktiviert sein (useSoapFaults=true) wird ein Fehler (Execption) geworfen.
-Diese Funktion liefert Ihnen ein Array der möglichen Farben und dessen Kürzel/Shortcuts, welche bei der Funktion calcCar(...) explizit übergeben werden können.
-  *  Parameter
+==== getLastError ====
- username (optional): Ihr Nutzername, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert.
- password (optional): Ihr Passwort, falls das Sessionhandling durch die Funktion login(...) nicht funktioniert.
-  *  Rückgabewert
- Liefert ein Array mit den möglichen Farben und dessen Kürzel/Shortcuts zurück. Im Fehlerfall wird ein leeres Array zurückgegeben. Sollte die Ausnahmebehandlung aktiviert sein (useSoapFaults=true) wird ein Fehler (Execption) geworfen.
+Syntax: ''array getLastError ()''
-===== getLastError =====
+Liefert den letzten aufgetretenen Fehler falls vorhanden.
-Syntax: <code>array getLastError () </code>
+  * Rückgabewert
+    * Liefert den Fehlercode (errorcode) und die Fehlerbeschreibung (faultstring) des letzten Fehlers zurück, falls ein Fehler aufgetreten ist. Liegt kein Fehler vor, sind die beiden zurückgegebenen Felder leer.
-Liefert den letzten aufgetretenen Fehler falls vorhanden.
-  *  Rückgabewert
+===== Tutorials =====
- Liefert den Fehlercode (errorcode) und die Fehlerbeschreibung (faultstring) des letzten Fehlers zurück, falls ein Fehler aufgetreten ist. Liegt kein Fehler vor, sind die beiden zurückgegebenen Felder leer.
+Im folgenden Abschnitt werden einige einfache Beispiele zur Verwendung der SOAP-Schnittstelle von Autofokus24.de dargestellt.
-====== Tutorials ======
-Im folgenden Abschnitt werden einige einfache Beispiele zur Verwendung der SOAP-Schnittstelle von Autofokus24.de dargestellt.
+==== PHP-Tutorial ====
-===== PHP-Tutorial =====
 Für die Verwendung in PHP benötigen Sie die [[http://www.php.net/manual/de/class.soapclient.php|PHP-SoapClient-Klasse]].
@@ Zeile 125: / Zeile 116: @@
 <code>
   <?php
    try {
    /* Initialisierung: WSDL-Datei angeben, Caching deaktivieren, Encoding festlegen*/
    $client = new SOAPClient('http://www.autofokus24.de/SoapServer.php?wsdl',
@@ Zeile 131: / Zeile 122: @@
                                    'encoding'=>'ISO-8859-1')
                             );
    /* Login: Mit eMail, Passwort. SoapFaults auf 1 setzen*/
    $client->login("mymail@myhost.de","meinpasswort",1);
    /* Fahrzeug ermitteln, Preis berechnen und Ergebnis formatiert ausgeben...*/
    print_r($client->calcCar("0999",                /* HSN */
                             "269",                 /* TSN */
@@ Zeile 158: / Zeile 149: @@
                      /* Türen = keine Angabe */
                             ));
    }catch (SOAPFault $f)
    {
      print $f->faultstring;
@@ Zeile 164: / Zeile 155: @@
    ?>
 </code>
 Ergibt folgende Ausgabe:
 <code>
   Array
@@ Zeile 231: / Zeile 224: @@
-===== Perl-Tutorial =====
+==== Perl-Tutorial ====
 Für die Verwendung in Perl benötigen Sie in diesem Tutorial das Paket SOAP::Lite sowie HTTP::Cookies, um das Sessionhandling zu ermöglichen.
@@ Zeile 240: / Zeile 233: @@
    use Data::Dumper;
    use HTTP::Cookies;
    # Initialisierung: Namespace angeben, Encoding angeben, SoapServer angeben, Cookies annehmen
    $service = SOAP::Lite
    -> uri('autofokus24') # Namespace
@@ Zeile 252: / Zeile 245: @@
    # Login: Mit eMail, Passwort
    my $loginresult = $service->login("mymail\@myhost.de","meinpasswort")->result();
    # Fahrzeug ermitteln, Preis berechnen.
    my $result = $service->calcCar("0999","269",2004,4,123000,
                             "
                             C 220 T CDI Automatik DPF,Sportpaket.Modell 2005
                             Brillantsilber met.,Leder Twin schwarz, Sportpaket,
@@ Zeile 267: / Zeile 260: @@
    print Dumper($result);
 </code>
 Ergibt folgende Ausgabe:
 <code>
   $VAR1 = [

Autofokus24 Wiki

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge