DOCUMENTATION DÉVELOPPEUR

Notes techniques pour développeurs sur l’intégration d’ADP Car Market Hub

Explorez la documentation publique pour développeurs d’ADP Car Market Hub : architecture, hooks, filtres, références API REST, actions AJAX, hooks cron, surcharges de modèles, consignes de sécurité, débogage et flux de publication.

Vue d’ensemble de la documentation développeur

La documentation développeur offre aux intégrateurs techniques un point d’entrée structuré vers l’architecture du plugin, les points d’extension, le comportement des endpoints et les flux de personnalisation sécurisés.

Architecture

Comprendre la structure du plugin, son cycle de vie, son modèle de données et ses responsabilités techniques avant toute extension ou intégration.

Architecture du plugin pour développeurs

Points d’extension

Utilisez les actions, filtres, hooks et points d’extension documentés plutôt que de modifier les fichiers cœur du plugin.

Hooks et filtres

API et traitements en arrière-plan

Examinez le comportement de l’API REST, les actions AJAX, les hooks cron et les limites des traitements planifiés.

API REST pour développeurs

Modèles et assets côté client

Utilisez les surcharges de modèles, les assets côté client et le comportement des shortcodes pour personnaliser la sortie en toute sécurité.

Système de modèles et surcharges

Sécurité et flux de publication

Suivez les contrôles de capacités, l’assainissement, l’échappement, les tests et les conseils de publication avant de déployer des changements.

Contrôles de sécurité et de capacités

Points d’entrée pour développeurs

Commencez par les documents qui correspondent à votre rôle et à votre tâche d’implémentation.

Architecture et orientation dans le code

Avant d’ajouter des intégrations ou des personnalisations, les développeurs doivent comprendre le cycle de vie du plugin, la structure du dépôt, le modèle de données et le comportement de stockage.

Sujets d’architecture cœur

  • Cycle de vie du plugin
  • Structure du dépôt
  • Modèle de données
  • Tables de base de données
  • Stockage des options et paramètres
  • Types de contenu personnalisés et taxonomies
  • Moteur d’import
  • File d’import des images
  • Planificateur cron

Points d’extension

Les intégrations sur mesure doivent utiliser des points d’extension documentés plutôt que de modifier les fichiers cœur du plugin.

Domaine d’extension Cas d’usage Document recommandé
Actions Réagir aux événements ou étapes de traitement du plugin Référence des actions
Filtres Modifier des valeurs ou la sortie via des points de filtre contrôlés Référence des filtres
Vue d’ensemble des hooks et filtres Comprendre les mécanismes d’extension disponibles Hooks et filtres
Points d’extension du moteur d’import Étendre ou ajuster le comportement lié aux imports en toute sécurité Points d’extension du moteur d’import
Points d’extension d’import des images Personnaliser la gestion des images ou le comportement de la file lorsque cela est pris en charge Points d’extension d’import des images
Points d’extension du traitement des leads Intégrer le traitement des leads à des flux externes Points d’extension du traitement des leads
Points d’extension des analyses Étendre le comportement lié aux analyses lorsque cela est pris en charge Points d’extension des analyses
Points d’extension de Market Insights Examiner les limites d’extension pour la logique liée au marché Points d’extension de Market Insights
Points d’extension du gestionnaire PDF Étendre ou personnaliser les flux liés aux PDF lorsque cela est pris en charge Points d’extension du gestionnaire PDF

API, AJAX et traitements en arrière-plan

Les développeurs doivent examiner le comportement des endpoints, les actions AJAX et les hooks cron avant d’étendre les flux techniques.

Modèles et assets côté client

La personnalisation côté client doit utiliser le système de modèles documenté, le comportement des shortcodes et la structure des assets.

Système de modèles

  • Surcharges de modèles
  • Sortie d’archive
  • Sortie de détail véhicule
  • Shortcodes
  • Modules côté client
  • Compatibilité avec le thème

Assets et comportement de l’interface

  • Assets côté client
  • Assets d’administration
  • Comportement responsive
  • Intégration aux page builders
  • CSS personnalisé
  • Contraintes de l’interface d’administration

Sécurité, assainissement et contrôles de capacités

Le travail des développeurs doit suivre les bonnes pratiques de sécurité WordPress et éviter d’exposer des données privées ou des opérations non sécurisées.

Pratiques requises

  • Utiliser les contrôles de capacités pour les actions privilégiées
  • Valider les nonces pour les actions AJAX et de formulaire
  • Assainir les données entrantes
  • Échapper les sorties
  • Éviter d’exposer les identifiants
  • Ne pas journaliser les valeurs sensibles
  • Utiliser des requêtes préparées en base de données
  • Respecter les paramètres de confidentialité et de conservation

Débogage, tests et flux de publication

Avant de déployer des changements, les développeurs doivent consulter la documentation sur la journalisation, le débogage, les tests et le flux de publication.

  1. Déboguer en local Utilisez les conseils de développement local et de journalisation pour reproduire les problèmes avant de modifier le comportement en production.
  2. Valider le comportement Testez les flux d’import, les réponses API, les hooks cron, la sortie côté client et les écrans d’administration après changements.
  3. Examiner la sécurité Vérifiez l’assainissement, l’échappement, les capacités et l’exposition des données publiques avant publication.
  4. Préparer la publication Suivez les conseils de publication, de build et de contribution avant de packager ou de déployer des changements.

Règles de la documentation développeur publique

La documentation développeur doit être utile aux partenaires d’implémentation sans exposer de détails d’implémentation privés.

Sûr à publier

  • Vues d’ensemble d’architecture
  • Hooks et filtres publics
  • Comportement général des endpoints
  • Conseils sur les surcharges de modèles
  • Conventions de codage
  • Flux de tests
  • Conseils de dépannage
  • Processus de publication
  • Points d’extension généraux

Ne publiez pas

  • Les secrets API
  • Les jetons d’accès privés
  • Les chemins de serveur internes
  • Les données client
  • Les URL d’API privées
  • Les identifiants bruts
  • Les détails d’exploit sensibles à la sécurité
  • Les notes d’implémentation confidentielles
  • Les notes de risques internes