Inhaltsverzeichnis

Dokumentation der SOAP Schnittstelle Version 3.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.

Eine allgemeine Beschreibung der SOAP-Schnittstelle finden Sie unter APIs.

SOAP-Zugangsdaten

Funktionen

login

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.

calcCar

Syntax: array calcCar(string hsn, string tsn, int year, int month, int miles [, string fuzzyText = "" [, string model = "" [, string subModel = "" [, string specialModel = "" [, bool returnAllSpecialmodels = false [, bool useProductionTolerance = false [, string featureList = "" [, string color = "" [, int buildType = 0 [, int doorCount = 0 [, int dealerSize = 0 [, int priceClass = 0 [, int carVolume = 0 [, int garantieValue = 0 [, int monthWaitForSell = 0 [, int milesPerYear = 0 [, int usageYearCount = 0 ]]]]]]]]]]]]]]]])

Diese Funktion liefert Ihnen ein Array mit den Daten des erkannten Fahrzeuges, sowie den berechneten Verkaufspreis (price) und den Händlereinkaufspreis (priceEK).

Wenn die Option returnAllSpecialmodels gesetzt ist, und wenn die übergebenen Parameter nicht eindeutig auf ein bestimmtes Sondermodell der Baureihe verweisen (häufig der Fall bei fehlender Angabe des Sondermodells (specialModel), dann wird eine Liste aus mehreren Arrays zurückgegeben. Für jedes mögliche Sondermodell werden alle Preise berechnet. Sie können dann programmseitig das korrekte Fahrzeug auswählen, oder die Parameter für eine erneute Anfrage entsprechend einschränken.

In seltenen Fällen ist die HSN/TSN Kombination nicht eindeutig hinsichtlich des Modells (nicht nur der Baureihe). Treffen mehrere verschiedene Modelle auf Ihre Anfrage zu, wird seit SOAP Version 2 ein Hinweis (HINT) mit der Liste zutreffender Modellbezeichnungen zurückgegeben. Sie erhalten in diesen Fällen keine Preisberechnungen zurück. Zum Beispiel trifft die HSN/TSN-Kombination 8566/AAH für die Modelle Ford Focus, Ford C-Max und Ford Kuga zu.

Seit Version 1.2 werden auch Standzeitinformationen (siehe Standzeiten) sowie Verkaufswahrscheinlichkeiten (siehe Verkaufswahrscheinlichkeit) zurückgegeben. Sie übergeben dazu die Option monthWaitForSell und übergeben die Dauer in Monaten, welche Fahrzeuge bei dem betrachteten Händler bzw. der Handelsplattform stehen sollen. Für sehr schnell drehende Händler übergeben Sie einen Wert von 1 (für einen Monat gewünschte Standzeit im Mittel). Wir empfehlen 3-4 Monate für größere Autohäuser, Markenhändler, damit die berechneten Preise nicht zu tief sind.

Die Option useProductionTolerance dehnt die Produktionszeiträume zur Suche nach passenden Fahrzeugen aus. Falls in der Fahrzeugbeschreibung eine falsch eingegebene EZ vorliegt, oder die EZ weit nach dem Ende des Produktionszeitraum war, werden Fahrzeuge normalerweise nicht gefunden. Die Toleranz dehnt das Suchintervall in unserer Datenbank nach vorne um 2 Monate, nach hinten um 12 Monate aus. Die Option ist auch sinnvoll, da die Angaben zu den Produktionsstarts in unseren Quellen teilweise nicht exakt sind.

Optional können auch weitere Parameter zur Händlergröße angegeben werden. Durch die Angaben der Händlerinformationen können realistischere Verkaufspreise ermittelt werden. Die Berechnung des Einkaufspreises bleibt davon unberührt. Zu den Händlerinformationen gehören die Parameter dealerSize, priceClass, carVolume sowie garantieValue. Weitere Informationen zur Händlergröße finden Sie unter Händlergrößen.

getFeatureList

Syntax: array getFeatureList ([username = "", password = ""])

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.

getColors

Syntax: array getColors ([username = "", password = ""])

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.

getLastError

Syntax: array getLastError ()

Liefert den letzten aufgetretenen Fehler falls vorhanden.

Tutorials

Im folgenden Abschnitt werden einige einfache Beispiele zur Verwendung der SOAP-Schnittstelle von Autofokus24.de dargestellt.

PHP-Tutorial

Für die Verwendung in PHP benötigen Sie die PHP-SoapClient-Klasse.

Code: 

<?php
try {
/* Initialisierung: WSDL-Datei angeben, Caching deaktivieren, Encoding festlegen*/
$client = new SOAPClient('https://autofokus24.de/genwsdl.php?type=hsntsn-v3',
                          array('cache_wsdl' => WSDL_CACHE_BOTH,
                                'encoding'=>'utf-8')
                         );
/* 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 */
                         2004,                 /* Jahr */
                         4,                    /* Monat */
                         123000,               /* Laufleistung */
                         "                     /* Freitext (aus Inserat) */
                         C 220 T CDI Automatik DPF,Sportpaket.Modell 2005
                         Brillantsilber met.,Leder Twin schwarz, Sportpaket,
                         AHK abnehmbar, Regensensor, Scheibenwaschanlage
                         beheizt, Radio Audio 20 CD, Klimaautomatik,
                         Sitzheizung, Automatikgetriebe 5 Gang,
                         Dieselpartikelfilter, LM-Felgen 17 Zoll,
                         Eingabefehler u.Irrtümer behalten wir uns vor.
                         ",
                         "Classic",            /* Sondermodell */
                         "XEN,PDC",      /* Explizite Ausstattungen */
                         "",                   /* Farbe, keine Angabe */
                         110,                  /* Motorleistung in Kilowatt */
                         2,                    /* Motorart = Diesel */
                         2,                    /* Aufbau = Kombi */
                         0,                    /* Türen = keine Angabe */
                         3,                     /* Unternehmensart = Freier Händler  */
                         2,                     /* Preisklasse = 5.000 - 10.000 €  */
                         4,                     /* Fahrzeugbestand = 20-50 */
                         2,                     /* Garantieleistungen = Verkäufe überwiegend mit Gewährleistung, ohne Garantie.  */
                         2                     /* Verkaufsperiode = 2 Monate */
                         ));
}catch (SOAPFault $f)
{
  print $f->faultstring;
}
?>

Ergibt folgende Ausgabe: 

Array
(
    [0] => Array
        (
            [make] => Mercedes-Benz
            [model] => C-Klasse
            [submodelName] => Modell ab 2004 (W203 Facelift)
            [buildKind] => KOMBI
            [specialModel] => Classic
            [power] => 110
            [doorCount] => 5
            [color] =>
            [fuel] => DIESEL
            [packets] => Array
                (
                    [0] => AMG/Sport Paket
                )
            [extras] => Array
                (
                    [PAK3] => 1
                    [KLI] => 1
                    [KLIAU] => 1
                    [AIB] => 1
                    [BAB] => 1
                    [SAB] => 1
                    [WFS] => 1
                    [KAB] => 1
                    [FAB] => 1
                    [ABSS] => 1
                    [AFLS] => 1
                    [BC] => 1
                    [BRA] => 1
                    [REL] => 1
                    [ESPI] => 1
                    [FH] => 1
                    [ESI] => 1
                    [ESP] => 1
                    [ASR] => 1
                    [NSW] => 1
                    [SV] => 1
                    [TMP] => 1
                    [Z] => 1
                    [ZF] => 1
                    [SVT] => 1
                    [XEN] => 1
                    [PDC] => 1
                    [LED] => 1
                    [LLR] => 1
                    [AHK] => 1
                    [CD] => 1
                    [ALU] => 1
                    [MET] => 1
                    [PF] => 1
                    [REG] => 1
                    [SOUND] => 1
                    [SIH] => 1
                    [NO_OGEW] => 1
                )
            [extrasByDate] => Array
                (
                    [KLI] => 1
                    [KLIAU] => 1
                    [AIB] => 1
                    [BAB] => 1
                    [SAB] => 1
                    [WFS] => 1
                    [KAB] => 1
                    [FAB] => 1
                    [ABSS] => 1
                    [AFLS] => 1
                    [BC] => 1
                    [BRA] => 1
                    [REL] => 1
                    [ESPI] => 1
                    [FH] => 1
                    [ESI] => 1
                    [ESP] => 1
                    [ASR] => 1
                    [NSW] => 1
                    [SV] => 1
                    [TMP] => 1
                    [Z] => 1
                    [ZF] => 1
                    [SVT] => 1
                )
            [significantExtras] => Array
                (
                    [0] => OGEW
                    [1] => LED
                    [2] => ALL
                    [3] => GAS
                    [4] => SHZG
                    [5] => NAV
                    [6] => NAV
                    [7] => AUTOMATIK
                    [8] => PF
                    [9] => SD
                    [10] => ALU
                    [11] => XEN
                    [12] => AHK
                    [13] => PDC
                    [14] => SIH
                    [15] => REG
                    [16] => GAR
                    [17] => WR
                    [18] => TLED
                    [19] => IAA
                    [20] => BXEN
                    [21] => SPSI
                    [22] => SOUND
                    [23] => OTUEV
                    [24] => LLR
                )
            [price] => 9096
            [priceEK] => 5967
            [avgSellingTimeAtPrice] => 41
            [avgSellingTimes] => Array
                (
                    [0] => Array
                        (
                            [0] => 8600
                            [1] => 85
                        )
                    [1] => Array
                        (
                            [0] => 8700
                            [1] => 83
                        )
                    [2] => Array
                        (
                            [0] => 8800
                            [1] => 80
                        )
                    [3] => Array
                        (
                            [0] => 8900
                            [1] => 78
                        )
                    [4] => Array
                        (
                            [0] => 9000
                            [1] => 75
                        )
                    [5] => Array
                        (
                            [0] => 9100
                            [1] => 73
                        )
                    [6] => Array
                        (
                            [0] => 9200
                            [1] => 70
                        )
                    [7] => Array
                        (
                            [0] => 9300
                            [1] => 68
                        )
                    [8] => Array
                        (
                            [0] => 9400
                            [1] => 65
                        )
                    [9] => Array
                        (
                            [0] => 9500
                            [1] => 63
                        )
                    [10] => Array
                        (
                            [0] => 9600
                            [1] => 60
                        )
                )
        )
)

An der Ausgabe ist zu erkennen, dass zunächst Marke, Modell und Submodell anhang der HSN/TSN erkannt und zugeordnet wurden. Die Farbe wurde automatisch anhand des Freitextes erkannt. Das Paket "Sport" wurde auch am Freitext erkannt. Weiterhin wurden die serienmäßigen Extras sowie die am Freitext erkannten Extras zugeordnet. Im Funktionsaufruf wurde das Kürzel "XEN" und "PDC" übergeben, wodurch diese Extras explizit übergeben wurden. Die Extras LED, LLR, AHK, CD, ALU, MET, PF, REG, SOUND, SIH wurden ebenfalls anhand des Freitextes erkannt. Schließlich wird der Verkaufspreis (price) und Händlereinkaufspreis (priceEK) zurückgegeben.