Wie kann ich die Marketplace API nutzen / testen?
Die Dokumentation ist über den folgenden Link aufrufbar:
Auf dieser Seite (HOME) sind auf diverse Links zu Inhalten und zum Testen enthalten:
- Unter "Getting Started" finden Sie allgemein Informationen zur API
- "API" ist der Direktaufruf der API verlinkt - ohne weitere Parameter wird es hier immer einen Serverfehler geben.
- "Swagger JSON" und "Swagger UI Dokumentation" (letzteres als externer Link ist selbsterklärend.
Grundsätzlich muss bei API Abfragen immer der API des Kunden mitgegeben werden. Dies ist in der Konfigurationsstrecke des Marketplaces 2.0 zu finden
Zwei Beispiele:
Home > Vehicles
https://api.pixel-base.de/marketplace/v3-11365/help/Resource?controllerName=Vehicles
Sie finden hier verschiedene Auswahlen für mögliche Abfragen, z.B. vehicles/byvin/{vin} :
https://api.pixel-base.de/marketplace/v3-11365/help/Resource?controllerName=Vehicles
Über den Punkt "GET" kommen Sie auf auf eine Seite, wo Sie Abfragen über "TRY THIS" testen können - der Aufruf wird direkt in die erste Zeile geschrieben:
In die "URI parameters" Zeile wird für dieses Beispiel der gewünschte Parameter geschrieben, also die VIN. Zusätzlich muss immer der API-Key ergänzt werden.
Hinweis:
- VIN und API Key sind für diese Beispiele verfremdet!
Ein Beispiel für ein Fahrzeug:
WBA12345678901234?apikey=12345678-abcd-9012-efgh-234567890123
Nach Eingabe wird der Link in der ersten Zeile automatisch ergänzt:
Mit "Send Request" wird die Abfrage gemacht und Daten werden gezogen:
Der komplette Aufruf für diese Konstellation lautet also
https://api.pixel-base.de/marketplace/v3-11365/vehicles/byvin/WB40S0105TS949951?apikey=12345678-abcd-9012-efgh-234567890123
https://api.pixel-base.de/marketplace/v3-11365/vehicles/byvin/WBA12345678901234?apikey=12345678-abcd-9012-efgh-234567890123
Ein weiterer Beispiellink ist z.B. dieser hier, mit dem Sie auf Aktionen im Automanager zugreifen können - z.B. zur Nutzung für Fahrzeugangebote:
https://api.pixel-base.de/marketplace/v3-11365/criteria/promotions?apikey=12345678-abcd-9012-efgh-234567890123
Die korrespondierenden Aktionen im Automanager finden Sie in der Aktionsübersicht:
Die in der API sichtbare Promotion ID sehen Sie im Automanager bei der Bearbeitung der jeweiligen Aktion in der URL, also z.B. https://bmwho.automanager.io/Aktionen/Configuration.aspx?id=6728&#step-3
Wichtig:
- Eine separate Dokumentation für die Integration von Online Sales Elementen wie z.B. der Inzahlungnahme auf selbständig erstellten Fahrzeugbörsen steht am Ende dieses Artikels zum Download bereit.