Accès à une API externe
L’accès à une API externe fournit les données véhicules importées et synchronisées dans WordPress.
Voir la documentation associéeAPI ET WEBHOOKS
Intégration API et webhook contrôlée pour les plateformes véhicules WordPress
Examinez la façon dont ADP Car Market Hub se connecte aux données véhicules externes, gère les identifiants API, expose les endpoints techniques, prend en charge les flux webhook et valide la communication réseau sécurisée.
Vue d’ensemble API et webhooks pour le plugin WordPress ADP Car Market Hub
Cette page récapitule les interfaces techniques utilisées pour connecter ADP Car Market Hub à des sources de données externes et aux flux d’intégration WordPress.
Gestion des identifiants
Les identifiants autorisent les requêtes API et ne doivent être stockés que dans les paramètres protégés du plugin.
Voir la documentation associéeEndpoints REST et AJAX
Les endpoints techniques soutiennent les opérations du plugin, les flux côté client et les interactions contrôlées dans l’administration WordPress.
Voir la documentation associéeFlux webhook
La documentation des webhooks explique comment les événements d’intégration ou les signaux externes peuvent être traités, lorsque cela est pris en charge.
Voir la documentation associéeDiagnostics et support
Les tests de connexion, les journaux et les documents de dépannage aident à identifier les requêtes en échec, les endpoints bloqués ou les erreurs de configuration.
Voir la documentation associéeArchitecture de connexion pour les flux API et webhook
Une intégration API fiable repose sur des requêtes sortantes sécurisées, des identifiants valides, une configuration correcte des endpoints et une gestion observable des erreurs.
- Source de données véhicules externe Fournit les données structurées d’inventaire véhicules via l’accès API configuré.
- Requête API HTTPS Le serveur WordPress doit pouvoir atteindre les endpoints externes via HTTPS sécurisé.
- Authentification et identifiants Les identifiants API valident l’accès et déterminent quel inventaire peut être récupéré.
- Plugin WordPress ADP Car Market Hub Gère la configuration, les tests de connexion, les imports et le traitement interne.
- Traitement des imports Transforme les données externes en enregistrements véhicules WordPress, métadonnées et médias.
- Base de données et bibliothèque de médias WordPress Stocke le contenu véhicule importé, les images, les paramètres, les journaux et les données opérationnelles associées.
- Flux REST, AJAX et côté client Soutiennent les actions d’administration contrôlées, les interactions côté client et le comportement d’intégration.
- Journaux, diagnostics et support Aident à diagnostiquer les défauts de connexion, les problèmes d’endpoint et les erreurs d’intégration.
Identifiants API et exigences d’accès
L’accès API doit être configuré avec soin, car les identifiants déterminent quelles données externes le plugin peut demander.
Valeurs requises
- URL de base de l’API
- URL du token
- Client ID
- Client Secret
- Identifiant vendeur ou identifiant de compte
- Environnement API
- Endpoint de test de connexion lorsqu’il est configuré
Règles de gestion des identifiants
- Ne publiez pas les identifiants dans la documentation
- Ne committez pas les identifiants dans des dépôts
- Stockez les identifiants uniquement dans les paramètres protégés du plugin
- Limitez l’accès à des administrateurs de confiance
- Confirmez les permissions du compte avant tout import
- Faites tourner les identifiants lorsque les accès changent
- Utilisez si possible des identifiants de pré-production pour les tests de pré-production
Réseau, SSL et test de connexion
La plupart des problèmes API sont causés par des requêtes sortantes bloquées, des identifiants invalides, des problèmes SSL, des URL incorrectes ou des problèmes de permissions de compte.
Site web HTTPS valide
URL d’API externe valide
Requêtes HTTPS sortantes autorisées
Aucun pare-feu d’hébergement bloquant les appels API
La résolution DNS fonctionne depuis le serveur
La chaîne du certificat SSL est valide
Endpoint du token joignable
URL de base de l’API joignable
Identifiants saisis correctement
Accès vendeur ou compte confirmé
Test de connexion exécuté
Journaux pertinents examinés
Surface API REST et AJAX exposée par le plugin
Le plugin peut utiliser des endpoints API REST et des actions AJAX pour des opérations d’administration contrôlées, des flux côté client et un comportement d’intégration.
Endpoints API REST
Technique
La documentation de l’API REST décrit la surface des endpoints du plugin, le comportement attendu et les limites d’utilisation technique.
- Espace de noms d’endpoint
- Objet de la requête
- Contexte d’authentification
- Réponses attendues
- Gestion des erreurs
- Contrôles de sécurité
Actions AJAX
Technique
La documentation AJAX décrit les interactions contrôlées d’administration ou côté client qui s’appuient sur le comportement AJAX de WordPress.
- Objet de l’action
- Contrôles des nonces
- Contrôles des capacités
- Validation des entrées
- Format de réponse
- Gestion des erreurs
Intégration de webhooks pour des flux pilotés par événements
La documentation des webhooks explique comment les événements d’intégration ou les signaux externes peuvent être traités lorsque cela est pris en charge par le flux du plugin.
Cas d’usage des webhooks
Utilisez les webhooks pour comprendre comment les schémas d’intégration pilotés par événements peuvent compléter les imports planifiés et les actions manuelles.
Intégration des webhooksTraitement des webhooks
Le traitement des webhooks doit valider la source de la requête, assainir les entrées, journaliser les échecs et éviter d’exposer des données privées.
Documentation technique des webhooksDépannage des webhooks
Les appels webhook en échec doivent être diagnostiqués via les journaux, l’accessibilité de l’endpoint, les contrôles d’authentification et la validation du payload.
DépannageLa disponibilité et le comportement des webhooks dépendent de la version du plugin installée et du scénario d’intégration configuré.
Règles de sécurité et opérationnelles pour les intégrations API
Les intégrations API et webhook doivent être documentées et exploitées sans exposer de données sensibles.
Bonnes pratiques d’intégration
- Utilisez HTTPS pour toute communication externe
- Limitez l’accès aux identifiants aux administrateurs autorisés
- Validez les URL d’API avant tout import
- Utilisez des identifiants de pré-production pour les tests lorsque c’est possible
- Surveillez les requêtes API en échec
- Examinez les journaux sans exposer de données personnelles
- Documentez uniquement le comportement public
Ne publiez pas
- Les client secrets
- Les tokens API
- Les URL d’API privées
- Les données client
- Les données personnelles
- Les payloads webhook bruts contenant des données privées
- Les chemins de serveur internes
- Les détails d’implémentation sensibles à la sécurité
Dépannage et diagnostics pour les problèmes API et webhook
Lorsque la communication API ou webhook échoue, commencez par les tests de connexion, les identifiants, les règles réseau et les journaux.
| Problème | Cause probable | Vérification recommandée | Documentation |
|---|---|---|---|
| Le test de connexion échoue | URL incorrecte, requête sortante bloquée ou problème SSL | Vérifiez l’URL de l’API, le DNS, le pare-feu d’hébergement et la chaîne SSL | Réseau et SSL de l’API Erreurs de connexion API |
| Échec d’authentification | Client ID, client secret, endpoint de token ou permissions de compte invalides | Vérifiez les identifiants et l’accès au compte vendeur | Mise en place des identifiants API Identifiants API externes |
| Les imports ne renvoient aucun véhicule | L’identifiant vendeur, le mappage de compte ou les permissions API ne correspondent pas à l’inventaire attendu | Vérifiez l’accès au compte et la configuration d’import | Mise en place de l’API AutoScout24 |
| Webhook non reçu | Endpoint inaccessible ou émetteur externe non configuré | Vérifiez l’URL du webhook, l’authentification et les journaux | Intégration des webhooks |
| Échec de la requête AJAX | Problème de nonce, de permission ou requête mal formée | Vérifiez la console du navigateur, les permissions admin et les journaux | Actions AJAX |
| Échec de la requête REST | Problème d’authentification, de capacité ou d’endpoint | Vérifiez l’espace de noms d’endpoint, la méthode de requête et la réponse | Endpoints API REST |
Références développeur pour les endpoints API et webhook
Les développeurs peuvent utiliser la documentation technique pour examiner le comportement des endpoints, les points d’extension, le traitement des requêtes et les limites d’intégration.
API REST pour développeurs
Référence technique pour les développeurs intégrant la surface API REST du plugin.
API REST pour développeursActions AJAX pour développeurs
Documentation développeur sur la gestion des actions AJAX, les nonces et les contrôles de capacités.
Actions AJAX pour développeursEndpoints API REST
Référence technique pour tous les endpoints REST exposés par le plugin.
Endpoints API RESTActions AJAX
Référence technique pour toutes les actions AJAX enregistrées par le plugin.
Actions AJAXWebhooks
Documentation technique sur le comportement et les schémas d’intégration des webhooks.
WebhooksContrôles de sécurité et de capacités
Schémas de sécurité, contrôles de capacités et contrôle d’accès pour les endpoints du plugin.
Documentation développeurAssainissement et échappement
Schémas d’assainissement des entrées et d’échappement des sorties utilisés dans le code du plugin.
Documentation développeurJournalisation et débogage
Journalisation, sortie de débogage et outillage de diagnostic disponibles pour les développeurs.
Documentation développeurGuide de tests
Conseils de tests et flux d’assurance qualité pour les intégrations du plugin.
Documentation développeurDocumentation API et webhooks dans le dépôt public
Ouvrez directement les documents API, webhook, réseau et développeur correspondants dans le dépôt de documentation public.
Guide d’intégration
Mise en route et prérequis
Documentation technique
- Endpoints API REST
- Actions AJAX
- Documentation technique des webhooks
- Section Documentation technique
Documentation développeur
- API REST pour développeurs
- Actions AJAX pour développeurs
- Section Documentation développeur
- Section Dépannage
Les liens de documentation suivent la langue active du site. L’anglais est la langue source. Les autres dossiers de langue utilisent des noms de dossiers et de fichiers localisés.