Externer API-Zugriff
Der externe API-Zugriff liefert die Fahrzeugdaten, die in WordPress importiert und synchronisiert werden.
Zugehörige Dokumentation anzeigenAPI UND WEBHOOKS
Kontrollierte API- und Webhook-Integration für WordPress-Fahrzeugplattformen
Überprüfen Sie, wie ADP Car Market Hub eine Verbindung zu externen Fahrzeugdaten herstellt, API-Zugangsdaten verwaltet, technische Endpunkte bereitstellt, Webhook-Workflows unterstützt und eine sichere Netzwerkkommunikation validiert.
API- und Webhook-Übersicht für das ADP Car Market Hub WordPress-Plugin
Diese Seite fasst die technischen Schnittstellen zusammen, über die ADP Car Market Hub mit externen Datenquellen und WordPress-basierten Integrations-Workflows verbunden wird.
Verwaltung der Zugangsdaten
Zugangsdaten autorisieren API-Anfragen und sollten ausschliesslich in geschützten Plugin-Einstellungen gespeichert werden.
Zugehörige Dokumentation anzeigenREST- und AJAX-Endpunkte
Technische Endpunkte unterstützen Plugin-Operationen, Frontend-Workflows und kontrollierte Interaktionen im WordPress-Admin.
Zugehörige Dokumentation anzeigenWebhook-Workflows
Die Webhook-Dokumentation erläutert, wie Integrationsereignisse oder externe Signale verarbeitet werden können, sofern dies unterstützt wird.
Zugehörige Dokumentation anzeigenDiagnose und Support
Verbindungstests, Protokolle und Troubleshooting-Dokumente helfen dabei, fehlgeschlagene Anfragen, blockierte Endpunkte oder Konfigurationsfehler zu erkennen.
Zugehörige Dokumentation anzeigenVerbindungsarchitektur für API- und Webhook-Workflows
Eine zuverlässige API-Integration setzt sichere ausgehende Anfragen, gültige Zugangsdaten, eine korrekte Endpunkt-Konfiguration und ein nachvollziehbares Fehlerhandling voraus.
- Externe Fahrzeugdatenquelle Stellt strukturierte Fahrzeugbestandsdaten über den konfigurierten API-Zugriff bereit.
- HTTPS-API-Anfrage Der WordPress-Server muss externe Endpunkte über sicheres HTTPS erreichen können.
- Authentifizierung und Zugangsdaten API-Zugangsdaten validieren den Zugriff und bestimmen, welcher Bestand abgerufen werden kann.
- ADP Car Market Hub WordPress-Plugin Übernimmt Konfiguration, Verbindungstests, Importe und interne Verarbeitung.
- Import-Verarbeitung Wandelt externe Daten in WordPress-Fahrzeugdatensätze, Metadaten und Medien um.
- WordPress-Datenbank und Mediathek Speichert importierte Fahrzeuginhalte, Bilder, Einstellungen, Protokolle und zugehörige Betriebsdaten.
- REST-, AJAX- und Frontend-Workflows Unterstützen kontrollierte Admin-Aktionen, Frontend-Interaktionen und Integrationsverhalten.
- Protokolle, Diagnose und Support Helfen bei der Diagnose von Verbindungsfehlern, Endpunkt-Problemen und Integrationsfehlern.
API-Zugangsdaten und Zugriffsanforderungen
Der API-Zugriff muss sorgfältig konfiguriert werden, da die Zugangsdaten festlegen, welche externen Daten das Plugin abrufen kann.
Erforderliche Werte
- API-Basis-URL
- Token-URL
- Client ID
- Client Secret
- Seller ID oder Konto-Identifier
- API-Umgebung
- Verbindungstest-Endpunkt, sofern konfiguriert
Regeln für den Umgang mit Zugangsdaten
- Keine Zugangsdaten in der Dokumentation veröffentlichen
- Keine Zugangsdaten in Repositories einchecken
- Zugangsdaten ausschliesslich in geschützten Plugin-Einstellungen speichern
- Zugriff auf vertrauenswürdige Administratoren beschränken
- Kontoberechtigungen vor dem Import bestätigen
- Zugangsdaten bei Zugriffsänderungen rotieren
- Wenn möglich Staging-Zugangsdaten für Staging-Tests verwenden
Netzwerk, SSL und Verbindungstests
Die meisten API-Probleme entstehen durch blockierte ausgehende Anfragen, ungültige Zugangsdaten, SSL-Probleme, falsche URLs oder unzureichende Kontoberechtigungen.
Gültige HTTPS-Website
Gültige externe API-URL
Ausgehende HTTPS-Anfragen erlaubt
Keine Hosting-Firewall, die API-Aufrufe blockiert
DNS-Auflösung funktioniert vom Server aus
SSL-Zertifikatskette ist gültig
Token-Endpunkt erreichbar
API-Basis-URL erreichbar
Zugangsdaten korrekt eingegeben
Verkäufer- oder Kontozugriff bestätigt
Verbindungstest abgeschlossen
Relevante Protokolle geprüft
Vom Plugin bereitgestellte REST-API- und AJAX-Schnittstellen
Das Plugin kann REST-API-Endpunkte und AJAX-Aktionen für kontrollierte Admin-Operationen, Frontend-Workflows und Integrationsverhalten nutzen.
REST-API-Endpunkte
Technisch
Die REST-API-Dokumentation beschreibt die Endpunkt-Oberfläche des Plugins, das erwartete Verhalten und die technischen Nutzungsgrenzen.
- Endpunkt-Namespace
- Zweck der Anfrage
- Authentifizierungs-Kontext
- Erwartete Antworten
- Fehlerbehandlung
- Sicherheitsprüfungen
AJAX-Aktionen
Technisch
Die AJAX-Dokumentation beschreibt kontrollierte Admin- oder Frontend-Interaktionen, die auf dem WordPress-AJAX-Verhalten basieren.
- Zweck der Aktion
- Nonce-Prüfungen
- Capability-Prüfungen
- Eingabe-Validierung
- Antwortformat
- Fehlerbehandlung
Webhook-Integration für ereignisgesteuerte Workflows
Die Webhook-Dokumentation erläutert, wie Integrationsereignisse oder externe Signale verarbeitet werden können, sofern dies vom Plugin-Workflow unterstützt wird.
Anwendungsfälle für Webhooks
Setzen Sie Webhooks ein, um zu verstehen, wie ereignisgesteuerte Integrationsmuster geplante Importe und manuelle Aktionen ergänzen können.
Webhook-IntegrationWebhook-Verarbeitung
Die Webhook-Verarbeitung sollte die Anfragequelle validieren, Eingaben bereinigen, Fehler protokollieren und die Offenlegung privater Daten vermeiden.
Technische Webhook-DokumentationWebhook-Troubleshooting
Fehlgeschlagene Webhook-Aufrufe sollten über Protokolle, Endpunkt-Erreichbarkeit, Authentifizierungsprüfungen und Payload-Validierung diagnostiziert werden.
TroubleshootingVerfügbarkeit und Verhalten von Webhooks hängen von der installierten Plugin-Version und vom konfigurierten Integrationsszenario ab.
Sicherheits- und Betriebsregeln für API-Integrationen
API- und Webhook-Integrationen sollten dokumentiert und betrieben werden, ohne sensible Daten offenzulegen.
Sichere Integrationspraktiken
- HTTPS für sämtliche externe Kommunikation verwenden
- Zugriff auf Zugangsdaten auf autorisierte Administratoren beschränken
- API-URLs vor dem Import validieren
- Wenn verfügbar Staging-Zugangsdaten für Tests verwenden
- Fehlgeschlagene API-Anfragen überwachen
- Protokolle prüfen, ohne personenbezogene Daten offenzulegen
- Ausschliesslich öffentliches Verhalten dokumentieren
Nicht veröffentlichen
- Client Secrets
- API-Tokens
- Private API-URLs
- Kundendaten
- Personenbezogene Daten
- Rohe Webhook-Payloads mit privaten Daten
- Interne Server-Pfade
- Sicherheitsrelevante Implementierungsdetails
Troubleshooting und Diagnose für API- und Webhook-Probleme
Bei fehlgeschlagener API- oder Webhook-Kommunikation beginnen Sie mit Verbindungstests, Zugangsdaten, Netzwerkregeln und Protokollen.
| Problem | Wahrscheinliche Ursache | Empfohlene Prüfung | Dokumentation |
|---|---|---|---|
| Verbindungstest schlägt fehl | Falsche URL, blockierte ausgehende Anfrage oder SSL-Problem | API-URL, DNS, Hosting-Firewall und SSL-Kette prüfen | API, Netzwerk und SSL API-Verbindungsfehler |
| Authentifizierung schlägt fehl | Ungültige Client ID, Client Secret, Token-Endpunkt oder Kontoberechtigungen | Zugangsdaten und Verkäuferkonto-Zugriff prüfen | API-Zugangsdaten-Einrichtung Externe API-Zugangsdaten |
| Importe liefern keine Fahrzeuge | Seller ID, Konto-Zuordnung oder API-Berechtigungen passen nicht zum erwarteten Bestand | Kontozugriff und Import-Konfiguration prüfen | AutoScout24 API-Einrichtung |
| Webhook nicht empfangen | Endpunkt nicht erreichbar oder externer Sender nicht konfiguriert | Webhook-URL, Authentifizierung und Protokolle prüfen | Webhook-Integration |
| AJAX-Anfrage schlägt fehl | Nonce-, Berechtigungs- oder Anfrageformat-Problem | Browser-Konsole, Admin-Berechtigungen und Protokolle prüfen | AJAX-Aktionen |
| REST-Anfrage schlägt fehl | Authentifizierungs-, Capability- oder Endpunkt-Problem | Endpunkt-Namespace, Anfragemethode und Antwort prüfen | REST-API-Endpunkte |
Entwicklerreferenzen für API- und Webhook-Endpunkte
Entwickler können die technische Dokumentation nutzen, um Endpunkt-Verhalten, Erweiterungspunkte, Anfrageverarbeitung und Integrationsgrenzen zu prüfen.
REST-API für Entwickler
Technische Referenz für Entwickler, die die REST-API-Schnittstelle des Plugins integrieren.
REST-API für EntwicklerAJAX-Aktionen für Entwickler
Entwicklerdokumentation zur AJAX-Aktionsverarbeitung, zu Nonces und Capability-Prüfungen.
AJAX-Aktionen für EntwicklerREST-API-Endpunkte
Technische Referenz für alle vom Plugin bereitgestellten REST-Endpunkte.
REST-API-EndpunkteAJAX-Aktionen
Technische Referenz für alle vom Plugin registrierten AJAX-Aktionen.
AJAX-AktionenWebhooks
Technische Dokumentation zum Webhook-Verhalten und zu Integrationsmustern.
WebhooksSicherheits- und Capability-Prüfungen
Sicherheitsmuster, Capability-Prüfungen und Zugriffskontrolle für Plugin-Endpunkte.
EntwicklerdokumentationSanitization und Escaping
In der gesamten Plugin-Codebasis verwendete Muster zur Eingabe-Sanitization und Ausgabe-Escaping.
EntwicklerdokumentationLogging und Debugging
Für Entwickler verfügbare Werkzeuge für Logging, Debug-Ausgaben und Diagnose.
EntwicklerdokumentationTestleitfaden
Test-Hinweise und Qualitätssicherungs-Workflows für Plugin-Integrationen.
EntwicklerdokumentationAPI- und Webhook-Dokumentation im öffentlichen Repository
Öffnen Sie die relevanten API-, Webhook-, Netzwerk- und Entwicklerdokumente direkt im öffentlichen Dokumentations-Repository.
Integrationsleitfaden
Einstieg und Voraussetzungen
Technische Dokumentation
- REST-API-Endpunkte
- AJAX-Aktionen
- Technische Webhook-Dokumentation
- Abschnitt Technische Dokumentation
Entwicklerdokumentation
- REST-API für Entwickler
- AJAX-Aktionen für Entwickler
- Abschnitt Entwicklerdokumentation
- Abschnitt Troubleshooting
Die Dokumentationslinks folgen der aktiven Website-Sprache. Englisch ist die Quellsprache. Weitere Sprachordner verwenden lokalisierte Ordner- und Dateinamen.