Dokumentation · Admin-Referenz
Referenz zum Einrichtungsassistenten
Dieses Dokument ist eine Referenz für den ersten Setup-Assistenten des ADP Car Market Hub-Plugins. Der Assistent ist ein siebenstufiger Onboarding-Prozess im Enterprise-Stil, der einem WordPress-Administrator hilft, die häufigsten Konfigurationsaufgaben direkt nach der ersten Aktivierung abzuschliessen.
Der Assistent ist optional. Jede Option, die er anbietet, kann auch manuell über die regulären Admin-Tabs konfiguriert werden, die an anderer Stelle in der Admin-Referenz dokumentiert sind. Die empfohlene Reihenfolge für die vollständige Einrichtung finden Sie unter Erste Einrichtung.
Wann Sie dieses Dokument verwenden sollten
Lesen Sie dies, wenn Sie Folgendes tun müssen:
- Verstehen, wann und wie der Willkommenshinweis für den Setup-Assistenten erscheint.
- Wissen, wie Sie den Assistenten starten, überspringen oder fortsetzen.
- Den Unterschied zwischen Demo-Einrichtung und Live-AutoScout24-Einrichtung verstehen.
- Wissen, welche Optionen der Assistent schreibt und welche Optionen er niemals stillschweigend überschreibt.
- Das Sicherheitsmodell verstehen (Berechtigungs- und Nonce-Schutz, Handhabung des Client Secret).
- Den Assistenten für eine interne Übergabe oder ein Kunden-Onboarding dokumentieren.
Übersicht
Der Assistent ist als versteckte Admin-Seite registriert unter:
wp-admin/admin.php?page=as24ci-setup-wizard
Er ist nicht im CMH Center-Untermenü aufgeführt. Einstiegspunkte sind:
- Der Admin-Hinweis Willkommen bei ADP Car Market Hub, der nach der ersten Aktivierung erscheint.
- Der Link Setup-Assistenten ausführen oben auf
CMH Center → Dashboard. - Die Karte Setup-Assistent oben auf
CMH Center → Tools.
Der Assistent leitet nach der Aktivierung niemals automatisch weiter. Der Admin-Hinweis dient der Information und bietet zwei Schaltflächen: Setup-Assistenten starten und Vorerst überspringen.
Anforderungen oder Voraussetzungen
- Ein WordPress-Benutzer mit der Verwaltungsberechtigung des Plugins (
Plugin::CAP_MANAGE). - Ein Zeitstempel der Erstaktivierung, der vom Aktivierungs-Hook des Plugins aufgezeichnet wurde. Bestehende Installationen, die ohne Reaktivierung aktualisiert werden, sehen den Willkommenshinweis nicht, können den Assistenten aber dennoch manuell über das Dashboard oder den Tools-Tab öffnen.
- Für die Live-Einrichtung: AutoScout24-API-Zugangsdaten (Client ID, Client Secret, Seller ID, API-Basis-URL).
- Für die Demo-Einrichtung: Es sind keine API-Zugangsdaten erforderlich.
Ablauf des Assistenten
Schritt 1 — Lizenzaktivierung
Der erste Schritt aktiviert die Plugin-Lizenz. Importe, die geplante Synchronisierung und die lizenzierten Funktionsrechte erfordern alle eine aktive Lizenz, daher fragt der Assistent diese als Erstes ab. Geben Sie Ihren Lizenzschlüssel hier ein und aktivieren Sie ihn; die restlichen Schritte werden freigeschaltet, sobald die Lizenz gültig ist.
Schritt 2 — Modus
Wählen Sie zwischen zwei Einrichtungspfaden:
- Demo-Einrichtung — installiert eine kuratierte Auswahl an Demofahrzeugen, wendet demofreundliche Standardeinstellungen an und aktiviert vorab das Analytics-Tracking, damit die Dashboard- und Analytics-Seiten Daten zum Anzeigen haben. Die Demo-Einrichtung ist ein expliziter Reset- und Seed-Vorgang: Sie löst nach Abschluss den bestehenden
Demo_Data::install()-Pfad aus. - Live-AutoScout24-Einrichtung — speichert echte AutoScout24-Zugangsdaten sowie die ausgewählten Seiten und Funktions-Toggles, installiert jedoch keine Demodaten und aktiviert Analytics nicht vorab.
Schritt 2 erfasst auch das Land der Garage (DE, CH, AT, Andere), die Standard-Währung (EUR, CHF) und die Admin-Sprache (Website-Standard plus eine kleine explizite Allowlist).
Schritt 3 — Garagen-Profil
Erfasst die grundlegenden Identitätsdaten der Garage, die von anderen Teilen des Plugins verwendet werden: Name, Strasse, Postleitzahl, Ort, Land, Telefon, E-Mail, Website und eine Logo-Medien-ID. Alle Felder sind optional. Übermittelte Werte werden bereinigt; leer gelassene Felder behalten den bestehenden gespeicherten Wert bei (kein Feld wird stillschweigend gelöscht).
Schritt 4 — AutoScout24
Erfasst die AutoScout24-API-Verbindung: Client ID, Client Secret, Seller ID und API-Basis-URL. Im Demo-Modus zeigt dieser Schritt einen Hinweis zum Überspringen an; im Live-Modus werden Zugangsdaten empfohlen. Der Assistent schreibt dieselben gespeicherten Optionen wie die dedizierte Quellseite, sodass diese Zugangsdaten auch später auf der Seite Verbindungen eingegeben oder geändert werden können, die nun die zentrale Anlaufstelle für alle Datenquellen-Verbindungen ist.
Das Feld Client Secret wird absichtlich leer dargestellt. Der Assistent schreibt das gespeicherte Secret niemals in das Admin-HTML zurück. Wenn Sie das Formular absenden und das Feld leer lassen (oder nur Leerzeichen enthält), bleibt das bestehende gespeicherte Secret erhalten. Das Absenden eines nicht leeren Werts ersetzt es. Das gespeicherte Secret wird verschlüsselt auf dem Server aufbewahrt. Dieselbe Regel (leer lassen zum Beibehalten) gilt auch auf der Seite Verbindungen, auf der die AutoScout24-Zugangsdaten nach der Einrichtung verwaltet werden.
Die Basis-URL wird mit einer http/https-Allowlist abgeglichen; andere Schemata (zum Beispiel javascript:) werden abgelehnt.
Schritt 5 — Seiten
Für jede öffentlich zugängliche Seite bietet der Assistent drei Modi an:
- Automatisch erstellen —
wp_insert_post()wird mitpost_type=page,post_status=publish, dem kanonischen Titel und dem kanonischen Shortcode als Seiteninhalt aufgerufen. Zuerst wird eine Titelsuche durchgeführt, um die Erstellung eines Duplikats zu vermeiden, falls bereits eine Seite mit demselben Titel existiert. - Bestehende Seite verwenden — der Administrator gibt die Post-ID einer bestehenden Seite ein und die entsprechende Option (
as24ci_page_archive_id,as24ci_page_compare_id,as24ci_page_favorites_id) wird aktualisiert. - Überspringen — die Seite wird nicht erstellt und der bestehende Optionswert bleibt erhalten.
Kanonische Seiten und Shortcodes:
| Seite | Shortcode | Option |
|---|---|---|
| Fahrzeuge | [as24ci_archive] | as24ci_page_archive_id |
| Fahrzeuge vergleichen | [as24ci_compare] | as24ci_page_compare_id |
| Favoriten | [as24ci_favorites] | as24ci_page_favorites_id |
Wenn die Option bereits auf eine bestehende Seite verweist (get_post() gibt eine veröffentlichte Seite zurück), behält der Assistent diese bei und erstellt kein Duplikat. Der Assistent löscht niemals bestehende Seiten.
Suchaufträge haben im Assistenten absichtlich keine öffentliche Seite. Abonnements für Suchaufträge werden über die [as24ci_archive]-Filter-Sidebar und über den Admin-Tab Referenz zu Suchaufträgen verwaltet.
Schritt 6 — Funktionen
Schaltet die gängigsten Standardfunktionen ein oder aus. Jedes Toggle wird mit einer expliziten Markierung für das Vorhandensein aufgezeichnet, sodass das erneute Ausführen des Assistenten zwischendurch niemals eine Einstellung löscht, die nicht auf dem Formular vorhanden war:
- Social-Sharing-Buttons
- PDF-Datenblatt
- QR-Code im PDF
- Betriebskosten pro 100 km
- Vergleichen
- Favoriten
- Suchaufträge
- Analytics-Tracking
Im Demo-Modus ist das Analytics-Tracking vorab aktiviert. Im Live-Modus ist es deaktiviert, es sei denn, der Administrator aktiviert es explizit.
Hintergrund-Standardeinstellungen, auf die sich der Assistent verlässt (Platzierung des Social Sharings, das vollständige Netzwerk-Set, Archiv-Layout = beide, Listen-Auszug = 150), werden nur dann eingespielt, wenn die entsprechende Option fehlt; bestehende Werte werden beibehalten.
Schritt 7 — Fertigstellen
Eine schreibgeschützte Zusammenfassung der getroffenen Auswahlen. Im Demo-Modus ist die Schaltfläche zum Fertigstellen mit Demodaten installieren und fertigstellen beschriftet und löst den bestehenden Demo_Data::install()-Pfad aus. Im Live-Modus speichert die Fertigstellen-Schaltfläche nur die vom Assistenten gesammelten Einstellungen.
Nach erfolgreichem Abschluss:
as24ci_setup_wizard_completedwird gesetzt.as24ci_setup_completed_atwird auf einen ISO-8601 UTC-Zeitstempel gesetzt.as24ci_setup_completed_bywird auf die WordPress-Benutzer-ID gesetzt.- Der Administrator wird mit einer Erfolgsmeldung zurück zum Dashboard geleitet.
Verhalten des Admin-Hinweises
Der Willkommenshinweis wird nur angezeigt, wenn alle folgenden Bedingungen erfüllt sind:
- Der aktuelle Benutzer verfügt über die Berechtigung zur Verwaltung des Plugins.
as24ci_setup_first_activation_atexistiert (wird vonPlugin::activate()nur aufgezeichnet, wenn es fehlt, sodass bestehende Installationen, die ohne erneute Aktivierung aktualisiert werden, nicht bedrängt werden).as24ci_setup_wizard_completedist nicht gesetzt.as24ci_setup_wizard_skippedis nicht gesetzt.- Der aktuelle Bildschirm ist nicht die Wizard-Seite selbst.
Es werden zwei Schaltflächen angeboten:
- Setup Wizard starten öffnet den Wizard.
- Vorerst überspringen sendet an
admin-post.php?action=as24ci_setup_wizard_skip(mit Berechtigungs- und Nonce-Prüfungen). Es setztas24ci_setup_wizard_skipped=1und leitet zurück zum Dashboard weiter. Der Hinweis erscheint bei nachfolgenden Ladevorgängen von Admin-Seiten nicht mehr.
Der Wizard erzwingt nach der Aktivierung niemals eine Weiterleitung.
Konfigurationsreferenz
Status-Optionen
| Option | Zweck |
|---|---|
as24ci_setup_first_activation_at | Zeitstempel der ersten Aktivierung. Einmalig über add_option() aufgezeichnet; wird bei späteren (Wieder-)Aktivierungen nie überschrieben. |
as24ci_setup_wizard_completed | Wird nach einem erfolgreichen Abschluss auf 1 gesetzt. |
as24ci_setup_wizard_skipped | Wird auf 1 gesetzt, wenn der Admin beim Willkommenshinweis auf Überspringen klickt. |
as24ci_setup_mode | Entweder demo oder live. |
as24ci_setup_completed_at | ISO-8601 UTC-Zeitstempel des Abschluss-Ereignisses. |
as24ci_setup_completed_by | WordPress-Benutzer-ID, die den Wizard abgeschlossen hat. |
Optionen für das Garagenprofil
as24ci_dealer_name, as24ci_dealer_street, as24ci_dealer_postal_code, as24ci_dealer_city, as24ci_dealer_country, as24ci_dealer_phone, as24ci_dealer_email, as24ci_dealer_website, as24ci_dealer_logo_id, as24ci_dealer_language.
Bestehende Optionen, die der Wizard beschreiben kann
CLIENT_ID, CLIENT_SECRET, SELLER_IDS, BASE_URL, DEFAULT_CURRENCY, FEATURE_SOCIAL_SHARE, SOCIAL_SHARE_PLACEMENT, SOCIAL_SHARE_NETWORKS, FEATURE_PDF_DATASHEET, FEATURE_COMPARE, FEATURE_FAVORITES, FEATURE_SEARCH_AGENT, ANALYTICS_ENABLED, ENVKV_SHOW_COSTS_100KM, PDF_MANAGER_SETTINGS (show_qr-Schlüssel), DESIGN_ARCHIVE_LAYOUT, ARCHIVE_LIST_EXCERPT_LENGTH, as24ci_page_archive_id, as24ci_page_compare_id, as24ci_page_favorites_id.
Der Wizard aktualisiert nur Optionen, deren Formularfelder tatsächlich im gesendeten POST-Payload vorhanden sind. Nicht gesendete Felder behalten ihren bestehenden Wert.
Sicherheit
- Berechtigungsprüfung. Jeder Einstiegspunkt (die Wizard-Seite, der Handler zum Speichern des Formulars und der Skip-Handler) ruft
current_user_can( Plugin::CAP_MANAGE )auf und bricht mitwp_die()ab, wenn die Berechtigung fehlt. - Nonces. Das Speichern des Formulars verwendet
wp_nonce_field()/check_admin_referer(); die Skip-URL verwendetwp_nonce_url()/check_admin_referer(). - Client Secret. Das gespeicherte Secret wird im Admin-HTML niemals erneut gerendert. Leere oder nur aus Leerzeichen bestehende Übermittlungen behalten den gespeicherten Wert bei.
- URL-Validierung. Basis-URL und Garagen-Website müssen das Schema
httpoderhttpsverwenden; andere Schemata werden abgelehnt. - E-Mail-Validierung. Die E-Mail-Adresse der Garage wird mit
is_email()validiert. Ungültige Eingaben behalten stillschweigend den bestehenden Wert bei; eine leere Übermittlung löscht ihn. - Bereinigung (Sanitization). Modus, Land, Währung, Sprache und Seitenmodus werden mit expliziten Whitelists abgeglichen. Textfelder verwenden
sanitize_text_field(). Seiten-IDs verwendenabsint(). - Ausgabe-Escaping. Jeder vom Wizard gerenderte dynamische Wert verwendet
esc_html,esc_attroderesc_url.
Betriebliche Hinweise
- Der Wizard ändert niemals Einstellungen bei der Plugin-Aktivierung. Die Aktivierung sät lediglich zerstörungsfreie Standardwerte über
add_option(). - Der Wizard ändert niemals Einstellungen, wenn ein Schritt geladen wird – Einstellungen werden nur aktualisiert, wenn der Admin einen Schritt absendet.
- Das Demo-Setup bleibt ein explizites Zurücksetzen und Einspeisen: Es setzt demo-gesteuerte Optionen bewusst zurück und fügt Demo-Fahrzeuge ein. Verwenden Sie dies nur auf dedizierten Demo- oder Test-Websites.
- Das Live-Setup ist in Bezug auf Fahrzeuge und Kundeneinstellungen zerstörungsfrei. Es speichert die im Wizard ausgewählten Einstellungen und Seiten, installiert jedoch keine Demodaten.
- Analytics ist nur im Demo-Modus vorab ausgewählt. Im Live-Modus ist der Schalter ein Opt-in (Schritt 6). Siehe Analytics-Aufbewahrung für Datenschutzüberlegungen.
- Der Wizard führt keine AI-Bereitstellung, automatischen Importe, Zeitpläne oder vollständigen Synchronisierungen durch. Diese werden später in den entsprechenden Admin-Tabs konfiguriert.
- Der Wizard ist kein Ersatz für ein Cookie-Consent-Tool, eine CMP, eine Datenschutzerklärung oder eine rechtliche Prüfung. Aktivieren Sie Analytics auf einer Live-Website erst, nachdem diese Anforderungen überprüft wurden.
Fehlerbehebung
- Der Willkommenshinweis erscheint nicht. Der Wizard wurde entweder abgeschlossen (
as24ci_setup_wizard_completed) oder übersprungen (as24ci_setup_wizard_skipped), dem aktuellen Benutzer fehlt die Verwaltungsberechtigung oder der Zeitstempel der Erstaktivierung wurde nicht aufgezeichnet (typisch für Upgrades, die keine neue Aktivierung ausgelöst haben). Öffnen Sie den Wizard stattdessen überCMH Center → Tools → Setup Wizard. - Ich habe den Wizard übersprungen. Wie öffne ich ihn wieder? Verwenden Sie den Link Setup Wizard ausführen auf
CMH Center → Dashboardoder die Karte Setup Wizard aufCMH Center → Tools. - Der Wizard hat meine Seiten nicht erstellt. Eine Seite mit demselben Titel existierte bereits und wurde wiederverwendet, oder die Option Überspringen wurde für diese Seite in Schritt 5 ausgewählt. Öffnen Sie
Pagesin WordPress und überprüfen Sie dies. Der Wizard löscht niemals Seiten. - Das Feld Client Secret ist leer, wenn ich Schritt 4 erneut öffne. Dies ist beabsichtigt. Das gespeicherte Secret wird nie wieder gerendert. Wenn Sie das Feld leer lassen, bleibt der gespeicherte Wert erhalten.
- Analytics ist nach dem Live-Setup nicht aktiviert. Im Live-Modus ist der Analytics-Schalter ein Opt-in. Öffnen Sie den Wizard erneut und aktivieren Sie ihn in Schritt 6, oder aktivieren Sie ihn im Tab Analytics. Überprüfen Sie vorher die Cookie-Einwilligung und die Datenschutzanforderungen.
- Demodaten wurden nicht installiert. Stellen Sie sicher, dass Sie in Schritt 2 Demo-Setup ausgewählt und in Schritt 7 auf Demodaten installieren und abschliessen geklickt haben. Das Live-Setup installiert keine Demodaten.
- Vergleich oder Favoriten sind in der Demo leer. Vergleich und Favoriten basieren auf localStorage; die Demo füllt einen Fallback aus, der den localStorage beim ersten Laden der Seite speist. Öffnen Sie die Vergleichs- oder Favoritenseite einmal in derselben Browsersitzung, um das Einspeisen auszulösen.
- Der Wizard überschreibt meine bestehenden Einstellungen nicht. Richtig. Der Wizard schreibt nur Optionen, deren Formularfelder abgesendet werden. Ein erneutes Ausführen auf halbem Weg löscht niemals unbezogene Einstellungen.