Dokumentation · Integrationshandbuch
AutoScout24 API-Einrichtung
Dieses Dokument erklärt, wie der AutoScout24-API-Zugriff in das ADP Car Market Hub-Plugin integriert ist, welche Zugangsdaten das Plugin benötigt und wie ein Administrator überprüfen kann, ob das Händlerkonto von der WordPress-Website aus erreichbar ist.
Der Fokus liegt hier auf der Integrationsseite der Arbeit – der Beziehung zwischen dem Plugin, dem AutoScout24-Konto des Händlers und den Personen, die den API-Zugriff bereitstellen. Eine schrittweise Anleitung für die Einstellungsseite Feld für Feld finden Sie unter API-Zugangsdaten einrichten.
Wann Sie dieses Dokument verwenden sollten
Verwenden Sie dieses Dokument, wenn Sie:
- Eine neue Integration des Plugins mit dem AutoScout24-API-Zugriff eines Händlers planen.
- Überprüfen möchten, ob ein Händler tatsächlich über die vom Plugin benötigte Art von API-Zugriff verfügt, bevor Sie mit der WordPress-Konfiguration beginnen.
- Sich mit einem Integrationspartner oder dem IT-Ansprechpartner des Händlers abstimmen, um API-Zugriffswerte zu erhalten oder zu rotieren.
- Nach der Konfiguration überprüfen möchten, ob die WordPress-Website die AutoScout24-API erreichen kann.
Die Zielgruppe ist ein WordPress-Administrator oder -Integrator, der mit der Person zusammenarbeitet, die den AutoScout24-API-Zugriff des Händlers verwaltet. AD Promotion stellt keinen AutoScout24-API-Zugriff aus; die Zugangsdaten stammen immer aus dem eigenen Konto des Händlers oder von dem Partner, der den Zugriff im Namen des Händlers bereitstellt.
Übersicht
ADP Car Market Hub basiert auf der offiziellen AutoScout24-API. Das Plugin authentifiziert sich mit einem OAuth2-Client-Credentials-Flow gegenüber einem vom Administrator konfigurierten API-Host, fordert ein Access-Token an und ruft dann die Fahrzeug-Endpunkte auf, um Fahrzeuge in den Custom Post Type as24ci_car zu importieren.
In der Praxis sind an der Integration drei unabhängige Parteien beteiligt:
- Der Händler (das Autohaus). Besitzt das AutoScout24-Konto und die Fahrzeugdaten des Händlers.
- Der API-Anbieter. AutoScout24 oder ein Integrationspartner, der AutoScout24-Daten über ein gleichwertiges Gateway bereitstellt. Diese Partei stellt die API-Basis-URL, die Verkäufer-ID(s) (Seller ID) und die OAuth Client-ID / das Client-Secret aus.
- Die WordPress-Website. Enthält die Plugin-Konfiguration, speichert die Zugangsdaten in der WordPress-Optionstabelle und führt die periodischen Importe aus.
Das Plugin verwendet genau den API-Host und die Zugangsdaten, die Sie konfigurieren – es gibt keinen fest einprogrammierten AutoScout24-Host im Plugin. Dies macht es möglich, dieselbe Plugin-Installation auf verschiedene Umgebungen auszurichten (z. B. eine Sandbox zum Testen und die Live-API für die Produktivseite), indem einfach die Konfiguration geändert wird.
Voraussetzungen
Bevor Sie die API-Verbindung des Plugins konfigurieren, überprüfen Sie bitte alle folgenden Punkte:
- Der Händler verfügt über einen API-Zugriff auf AutoScout24 (oder ein gleichwertiges Integrations-Gateway) für die zu importierenden Verkäufer-IDs (Seller IDs). Der standardmäßige Login für die AutoScout24-Händler-Website ist keine API-Zugangsdaten-Kombination und kann vom Plugin nicht verwendet werden.
- Sie haben über einen sicheren Kanal die Werte erhalten, die das Plugin benötigt:
- API-Basis-URL – die vollständige HTTPS-URL der AutoScout24-Umgebung oder des Partner-Gateways.
- Verkäufer-ID (Seller ID) (eine oder mehrere) – die vom API-Anbieter vergebenen, dauerhaften Konto-Identifikatoren. Die Verkäufer-ID ist nicht der Anzeigename des Händlers auf der AutoScout24-Website.
- Client-ID – der OAuth-Client-Identifikator.
- Client-Secret – das OAuth-Client-Secret, das zur Client-ID gehört.
- Die WordPress-Website erfüllt die Anforderungen an Hosting, PHP / Datenbank sowie API, Netzwerk und SSL. Ausgehende HTTPS-Verbindungen zum API-Host müssen zulässig sein.
- Ein Administrator-Konto ist auf der WordPress-Website verfügbar.
Wenn einer dieser Werte unbekannt ist, erfinden Sie ihn nicht. Wenden Sie sich an die Partei, die den API-Zugriff des Händlers bereitgestellt hat, und fordern Sie diese über einen sicheren Kanal an.
Schritt-für-Schritt-Anleitung
Die detaillierte Anleitung für die Benutzeroberfläche der Einstellungen finden Sie unter API-Zugangsdaten einrichten. Der übergeordnete Integrationsablauf ist wie folgt:
- API-Zugriff mit dem Anbieter bestätigen. Stellen Sie sicher, dass der API-Zugriff des Händlers aktiv ist, dass das Paar aus Client-ID und Client-Secret gültig ist und dass die Zugangsdaten für jede zu importierende Verkäufer-ID autorisiert sind. Autohäuser mit mehreren Standorten/Verkäufer-IDs benötigen in der Regel eine explizite Autorisierung pro Verkäufer-ID.
- Werte sicher entgegennehmen. Verwenden Sie einen Passwort-Manager, eine verschlüsselte Nachricht oder eine andere sichere Dateiübertragungsmethode. Akzeptieren Sie Zugangsdaten nicht per unverschlüsselter E-Mail oder Chat.
- Plugin konfigurieren. Öffnen Sie in WordPress den Pfad Car Market Hub → Einstellungen und tragen Sie die API-Basis-URL, die Verkäufer-ID, die Client-ID und das Client-Secret in die Karte API-Verbindung & Allgemeine Einstellungen ein.
- Verbindungstest ausführen. Öffnen Sie Car Market Hub → Werkzeuge und führen Sie den API-Verbindungstest aus, wie in Verbindungstest beschrieben. Beginnen Sie erst mit dem Import von Fahrzeugen, wenn der Test erfolgreich war.
- Zuerst einen kleinen Testimport durchführen. Verwenden Sie den Batch-Wizard oder einen einzelnen geplanten Durchlauf mit einem niedrigen Fahrzeuglimit, bevor Sie die vollständige Automatisierung aktivieren. Dies validiert das End-to-End-Verhalten, ohne beim ersten Versuch den gesamten Katalog zu importieren.
- Geplante Importe aktivieren. Sobald der manuelle Import funktioniert, aktivieren Sie WP-Cron oder richten Sie einen Server-Cron-Trigger ein. Siehe Server-Cron-Einrichtung.
Falls auf dem Weg Probleme auftreten, lesen Sie API-Verbindungsfehler, bevor Sie die Konfiguration anpassen.
Konfigurationsreferenz
Das Plugin zeigt nur die Felder an, die für die Kommunikation mit der konfigurierten AutoScout24-Umgebung erforderlich sind. Die unten stehenden Bezeichnungen entsprechen den Bezeichnungen unter Car Market Hub → Einstellungen.
| Feld | Zweck | Quelle |
|---|---|---|
| API-Basis-URL | Vollständige HTTPS-URL der AutoScout24-Umgebung oder des Partner-Gateways. Das Plugin verwendet diese URL genau wie konfiguriert. | Bereitgestellt von AutoScout24 oder dem Integrationspartner. |
| Verkäufer-ID (Seller ID) | Ein oder mehrere Identifikatoren für Händlerkonten. Mehrere Verkäufer-IDs werden kommagetrennt eingegeben. | Zusammen mit dem API-Zugriff bereitgestellt. Nicht der Anzeigename des Händlers auf der AutoScout24-Website. |
| Client-ID | OAuth-Client-Identifikator. Vertraulich zu behandeln, auch wenn es sich technisch gesehen nicht um ein Geheimnis handelt. | Ausgestellt vom API-Anbieter. |
| Client-Secret | OAuth-Client-Secret. Wird in der WordPress-Optionstabelle gespeichert; als sensible Zugangsdaten zu behandeln. | Ausgestellt vom API-Anbieter. Bei Verlust muss es in der Regel neu ausgestellt werden – es kann nicht wiederhergestellt werden. |
| Standardwährung | Wird verwendet, wenn ein importiertes Fahrzeugangebot keinen Währungswert bereitstellt. Keine Zugangsdaten. | Vom Administrator basierend auf dem Markt des Händlers ausgewählt. |
Das Plugin leitet den OAuth-Token-Endpunkt und die Token-Audience automatisch aus der konfigurierten API-Basis-URL ab; es gibt dafür kein separates Feld in der Benutzeroberfläche. Wenn der API-Anbieter nicht standardmäßige Werte benötigt, wenden Sie sich an AD Promotion oder den Integrationspartner, bevor Sie Änderungen vornehmen – die Standardableitung ist das, was die meisten Umgebungen erwarten.
Betriebliche Hinweise
- Speicherung. Zugangsdaten werden als WordPress-Optionen gespeichert. Jeder mit WordPress-Administratorzugriff, Dateisystemzugriff auf die Datenbank oder Zugriff auf ein Datenbank-Backup kann sie lesen. Wenden Sie dieselben Schutzmaßnahmen an wie für alle anderen Geheimnisse, die Ihr Unternehmen verwaltet.
- Token-Caching. Das Plugin fordert vor seinem ersten API-Aufruf ein OAuth-Access-Token an und speichert dieses im Cache. Nachfolgende Importe verwenden das zwischengespeicherte Token wieder, bis es abläuft. Nach dem Rotieren von Zugangsdaten empfiehlt es sich, den Token-Cache unter Car Market Hub → Werkzeuge zu leeren, damit die nächste Anfrage sofort die neuen Zugangsdaten verwendet.
- Installationen mit mehreren Umgebungen. Das Plugin verfügt über keinen integrierten Schalter für Produktion / Sandbox. Das Wechseln von Umgebungen bedeutet, dass die API-Basis-URL, die Verkäufer-ID, die Client-ID und das Client-Secret auf die Werte der Zielumgebung geändert und der Verbindungstest erneut durchgeführt werden müssen. Verwenden Sie separate Zugangsdaten pro WordPress-Umgebung, damit Aktivitäten auf der Staging-Umgebung nicht versehentlich die Produktionsdaten beeinträchtigen.
- Autohäuser mit mehreren Verkäufer-IDs. Wenn mehrere Verkäufer-IDs konfiguriert sind, werden alle mit derselben Client-ID / demselben Client-Secret abgefragt. Die Zugangsdaten müssen für jede Verkäufer-ID in der Liste autorisiert sein – andernfalls schlagen einzelne Verkäufer während des Imports mit einem Autorisierungsfehler fehl.
- Protokollierung (Logging). API-Aufrufe und Token-Anfragen werden im Log-Verzeichnis des Plugins unter
wp-content/uploads/as24ci-logs/protokolliert. Die Logs enthalten genügend Details zur Diagnose von Problemen, aber das Client-Secret wird nicht im Klartext geschrieben. Behandeln Sie das Log-Verzeichnis vertraulich. - Abstimmung mit dem API-Anbieter. Das Plugin kann nur das tun, was der API-Anbieter zulässt. Wenn der API-Zugriff des Händlers gesperrt, gedrosselt oder auf eine Teilmenge von Verkäufer-IDs beschränkt ist, meldet das Plugin diese Fehler, kann sie jedoch nicht umgehen. Klären Sie solche Probleme immer mit der Partei, die den Zugriff bereitgestellt hat.
Überprüfung des Kontozugriffs
Überprüfen Sie nach der Konfiguration des Plugins den Zugriff in dieser Reihenfolge:
- Verbindungstest. Führen Sie den API-Verbindungstest unter Car Market Hub → Werkzeuge aus. Ein erfolgreiches Ergebnis bestätigt, dass die API-Basis-URL erreichbar ist, der OAuth-Flow erfolgreich ist und die erste konfigurierte Verkäufer-ID von der API erkannt wird. Siehe Verbindungstest.
- Manueller Import einer kleinen Charge. Verwenden Sie den Batch-Wizard, um eine kleine Anzahl von Fahrzeugen zu importieren. Vergewissern Sie sich, dass die Fahrzeuge unter Car Market Hub → Fahrzeuge erscheinen und dass Preise, Währung und grundlegende Attribute korrekt aussehen.
- Überprüfung des Bildimports. Bestätigen Sie, dass das erste Bild jedes Testfahrzeugs heruntergeladen und angehängt wurde. Wenn die Bildverarbeitung in der Warteschlange steht, überprüfen Sie den Status der Bildwarteschlange unter Car Market Hub → Import & Limits.
- Tab „System & Hilfe“. Überprüfen Sie die Diagnoseanzeigen auf dem Tab „System & Hilfe“, um sicherzustellen, dass keine ausstehenden Warnungen bezüglich API-Konnektivität, Zeitplanung oder Speicherplatz vorliegen.
Überprüfen Sie diesen Validierungsablauf in der aktuellen Plugin-Version, bevor Sie Anweisungen für Kunden veröffentlichen, da sich die Bezeichnungen der Benutzeroberfläche zwischen den Versionen ändern können.
Fehlerbehebung
| Symptom | Wahrscheinliche Ursache | Was zu prüfen ist |
|---|---|---|
| Verbindungstest meldet einen Authentifizierungsfehler. | Falsche Client-ID / Client-Secret, falsche Umgebung oder eingefügte Leerzeichen in einem Zugangsdatenfeld. | Geben Sie sowohl Client-ID als auch Client-Secret erneut ein. Bestätigen Sie mit dem API-Anbieter, dass die Werte für die konfigurierte API-Basis-URL gültig sind. |
| Verbindungstest meldet „keine Verkäufer-ID konfiguriert“. | Das Feld für die Verkäufer-ID wurde nicht gespeichert oder enthält nur Leerzeichen / ein überflüssiges Komma. | Öffnen Sie die Einstellungen erneut, geben Sie die Verkäufer-ID neu ein und speichern Sie erneut. |
| Verbindungstest schlägt mit einem Netzwerk- oder SSL-Fehler fehl. | Ausgehende HTTPS-Verbindungen zum API-Host sind blockiert, das CA-Bundle des Servers ist veraltet oder DNS löst den Host nicht auf. | Siehe API-, Netzwerk- und SSL-Anforderungen und API-Verbindungsfehler. |
| Verbindung funktioniert, aber für eine bestimmte Verkäufer-ID werden keine Fahrzeuge importiert. | Die Zugangsdaten sind für diese Verkäufer-ID nicht autorisiert oder der Verkäufer hat keine aktiven Inserate veröffentlicht. | Kontaktieren Sie den API-Anbieter, um die Autorisierung zu bestätigen. Überprüfen Sie im AutoScout24-Konto des Händlers, ob die Inserate aktiv sind. |
| Nach dem Rotieren der Zugangsdaten scheinen immer noch die alten verwendet zu werden. | Das zwischengespeicherte Access-Token ist noch nicht abgelaufen. | Leeren Sie den Token-Cache unter Car Market Hub → Werkzeuge und führen Sie den Verbindungstest erneut aus. |
| Import funktioniert teilweise, aber einige Fahrzeuge schlagen wiederholt fehl. | Datenprobleme auf Anbieterseite oder Ratenbegrenzung (Rate Limiting) der API. | Überprüfen Sie die Plugin-Logs in wp-content/uploads/as24ci-logs/ und melden Sie wiederholbare Fehler mit den entsprechenden Log-Auszügen (mit geschwärzten Geheimnissen) an den API-Anbieter. |