Dokumentation · Integrationshandbuch

AutoScout24 API-Einrichtung

Dieses Dokument erklärt, wie der AutoScout24 API-Zugriff in das ADP Car Market Hub-Plugin passt, welche Zugangsdaten das Plugin benötigt und wie ein Administrator überprüfen kann, ob das Garagen-Konto von der WordPress-Website aus erreichbar ist.

Der Fokus liegt hier auf der Integrationsseite der Arbeit – der Beziehung zwischen dem Plugin, dem AutoScout24-Konto der Garage und den Personen, die den API-Zugriff bereitstellen. Für die schrittweise Anleitung der Einstellungsseite Feld für Feld siehe Einrichtung der API-Zugangsdaten.

Wann dieses Dokument zu verwenden ist

Verwenden Sie dieses Dokument, wenn Sie:

  • Eine neue Integration des Plugins mit dem AutoScout24 API-Zugriff einer Garage planen.
  • Überprüfen, ob eine Garage 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 der Garage abstimmen, um API-Zugriffswerte zu erhalten oder zu rotieren.
  • Nach der Konfiguration überprüfen, 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 der Garage verwaltet. AD Promotion stellt keinen AutoScout24 API-Zugriff aus; die Zugangsdaten stammen immer vom eigenen Konto der Garage oder vom Partner, der den Zugriff im Namen der Garage 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 Listings-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:

  • Die Garage. Besitzt das AutoScout24-Konto und die Fahrzeugdaten der Garage.
  • Der API-Anbieter. AutoScout24 oder ein Integrationspartner, der AutoScout24-Daten über ein gleichwertiges Gateway bereitstellt. Diese Partei stellt die API-Basis-URL, die Seller ID(s) und die OAuth Client ID / 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 produktive Website), indem einfach die Konfiguration geändert wird.

Voraussetzungen

Bestätigen Sie vor der Konfiguration der API-Verbindung des Plugins alle folgenden Punkte:

  • Die Garage verfügt über API-Zugriff auf AutoScout24 (oder auf ein gleichwertiges Integrations-Gateway) für die Seller ID(s), die importiert werden sollen. Der standardmässige AutoScout24-Login für Garagen-Websites 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.
  • Seller ID (eine oder mehrere) – die vom API-Anbieter ausgestellte, stabile Konto-ID. Die Seller ID ist nicht der Anzeigename der Garage auf der AutoScout24-Website.
  • Client ID – die OAuth-Client-Kennung.
  • Client Secret – das OAuth-Client-Geheimnis, das zur Client ID gehört.
  • Die WordPress-Website erfüllt die Hosting-Anforderungen, die PHP- und Datenbank-Anforderungen sowie die API-, Netzwerk- und SSL-Anforderungen. Ausgehender HTTPS-Verkehr zum API-Host muss erlaubt sein.
  • Ein Administrator-Konto ist auf der WordPress-Website verfügbar.

Wenn einer dieser Werte unbekannt ist, erfinden Sie ihn nicht. Kontaktieren Sie die Partei, die den API-Zugriff der Garage bereitgestellt hat, und fordern Sie die Daten über einen sicheren Kanal an.

Schritt-für-Schritt-Anleitung

Die detaillierte Anleitung für die Einstellungs-Benutzeroberfläche finden Sie unter Einrichtung der API-Zugangsdaten. Der übergeordnete Integrationsablauf ist wie folgt:

  1. API-Zugriff beim Anbieter bestätigen. Überprüfen Sie, ob der API-Zugriff der Garage aktiv ist, ob das Paar aus Client ID / Client Secret gültig ist und ob die Zugangsdaten für jede zu importierende Seller ID autorisiert sind. Mehrmarken-Garagen oder Garagengruppen benötigen in der Regel eine explizite Autorisierung pro Seller ID.
  2. Werte sicher empfangen. 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.
  3. Plugin konfigurieren. Öffnen Sie in WordPress Car Market Hub → Settings und geben Sie die API-Basis-URL, Seller ID, Client ID und das Client Secret in der Karte API Connection & General Settings ein.
  4. Verbindungstest ausführen. Öffnen Sie Car Market Hub → Tools und führen Sie den API-Verbindungstest aus, wie unter Verbindungstest beschrieben. Starten Sie den Fahrzeugimport erst, wenn der Test erfolgreich war.
  5. Zuerst einen kleinen Import durchführen. Verwenden Sie den Batch-Wizard oder einen einzelnen geplanten Durchlauf mit einem niedrigen Fahrzeuglimit, bevor Sie die vollständige Automatisierung aktivieren. Dies überprüft das End-to-End-Verhalten, ohne beim ersten Versuch den gesamten Katalog zu importieren.
  6. 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.

Konfigurations-Referenz

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 → Settings.

FeldZweckQuelle
API Base URLVollständige HTTPS-URL der AutoScout24-Umgebung oder des Partner-Gateways. Das Plugin verwendet diese URL genau wie konfiguriert.Bereitgestellt von AutoScout24 oder dem Integrationspartner.
Seller IDEine oder mehrere Garagen-Konto-IDs. Mehrere Seller IDs werden durch Komma getrennt eingegeben.Zusammen mit dem API-Zugriff bereitgestellt. Nicht der Anzeigename der Garage auf der AutoScout24-Website.
Client IDOAuth-Client-Kennung. Vertraulich zu behandeln, auch wenn es sich technisch gesehen nicht um ein Geheimnis handelt.Ausgestellt vom API-Anbieter.
Client SecretOAuth-Client-Geheimnis. Wird in der WordPress-Optionstabelle gespeichert; als sensible Zugangsdaten behandeln.Ausgestellt vom API-Anbieter. Bei Verlust muss es normalerweise neu ausgestellt werden – es kann nicht wiederhergestellt werden.
Default currencyWird verwendet, wenn ein importiertes Inserat keine Währung angibt. Keine Zugangsdaten.Vom Administrator basierend auf dem Markt der Garage ausgewählt.

Das Plugin leitet den OAuth-Token-Endpunkt und die Token-Audience automatisch aus der konfigurierten API-Basis-URL ab; es gibt kein separates UI-Feld dafür. Wenn der API-Anbieter nicht-standardmässige Werte verlangt, kontaktieren Sie AD Promotion oder den Integrationspartner, bevor Sie etwas ändern – 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 Schutzmassnahmen 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 es im Cache. Nachfolgende Importe verwenden das zwischengespeicherte Token wieder, bis es abläuft. Nach dem Rotieren von Zugangsdaten ist es ratsam, den Token-Cache unter Car Market Hub → Tools zu leeren, damit die nächste Anfrage sofort die neuen Zugangsdaten verwendet.
  • Multi-Umgebungs-Installationen. Das Plugin verfügt über keinen integrierten Schalter für Produktion / Sandbox. Das Wechseln der Umgebung bedeutet, dass die API-Basis-URL, die Seller ID, die Client ID und das Client Secret auf die Werte der Zielumgebung geändert und der Verbindungstest erneut ausgeführt werden müssen. Verwenden Sie separate Zugangsdaten pro WordPress-Umgebung, damit Staging-Aktivitäten nicht versehentlich Produktionsdaten beeinträchtigen.
  • Mehrmarken-Garagen / Garagengruppen. Wenn mehrere Seller IDs konfiguriert sind, werden alle mit derselben Client ID / Client Secret abgefragt. Die Zugangsdaten müssen für jede Seller ID in der Liste autorisiert sein – andernfalls schlagen einzelne Verkäufer während des Imports mit einem Autorisierungsfehler fehl.
  • Protokollierung. API-Aufrufe und Token-Anfragen werden im Log-Verzeichnis des Plugins in 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 der Garage gesperrt, gedrosselt oder auf eine Teilmenge von Seller IDs beschränkt ist, meldet das Plugin diese Fehler, kann sie jedoch nicht umgehen. Wenden Sie sich bei solchen Problemen immer an die Partei, die den Zugriff bereitgestellt hat.

Überprüfung des Kontozugriffs

Überprüfen Sie nach der Konfiguration des Plugins den Zugriff in dieser Reihenfolge:

  1. Verbindungstest. Führen Sie den API-Verbindungstest unter Car Market Hub → Tools aus. Ein erfolgreiches Ergebnis bestätigt, dass die API-Basis-URL erreichbar ist, dass der OAuth-Flow erfolgreich ist und dass die erste konfigurierte Seller ID von der API erkannt wird. Siehe Verbindungstest.
  2. Manueller Import eines kleinen Batches. Verwenden Sie den Batch-Wizard, um eine kleine Anzahl von Fahrzeugen zu importieren. Bestätigen Sie, dass die Inserate unter Car Market Hub → Cars erscheinen und dass Preise, Währung und grundlegende Attribute korrekt aussehen.
  3. Ü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.
  4. Registerkarte System & Help. Überprüfen Sie die Diagnoseanzeigen auf der Registerkarte System & Help, um sicherzustellen, dass keine ausstehenden Warnungen bezüglich API-Konnektivität, Zeitplanung oder Speicher vorliegen.

Überprüfen Sie diesen Validierungsablauf in der aktuellen Plugin-Version, bevor Sie Anweisungen für Kunden veröffentlichen, da sich die UI-Bezeichnungen zwischen den Versionen ändern können.

Fehlerbehebung

SymptomWahrscheinliche UrsacheWas zu prüfen ist
Der Verbindungstest meldet einen Authentifizierungsfehler.Falsche Client ID / Client Secret, falsche Umgebung oder Leerzeichen in ein Zugangsdatenfeld kopiert.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.
Der Verbindungstest meldet "no Seller ID configured".Das Feld Seller ID wurde nicht gespeichert oder enthält nur Leerzeichen / ein überflüssiges Komma.Öffnen Sie die Einstellungen erneut, geben Sie die Seller ID neu ein und speichern Sie erneut.
Der Verbindungstest schlägt mit einem Netzwerk- oder SSL-Fehler fehl.Ausgehender HTTPS-Verkehr zum API-Host ist 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.
Die Verbindung funktioniert, aber für eine bestimmte Seller ID werden keine Fahrzeuge importiert.Die Zugangsdaten sind für diese Seller ID nicht autorisiert, oder der Verkäufer hat keine aktiven Inserate.Kontaktieren Sie den API-Anbieter, um die Autorisierung zu bestätigen. Überprüfen Sie im AutoScout24-Konto der Garage, ob 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 → Tools und führen Sie den Verbindungstest erneut aus.
Der 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 dem API-Anbieter mit den entsprechenden Log-Auszügen (Geheimnisse unkenntlich machen).

Verwandte Dokumente