Documentazione · Documentazione per gli sviluppatori
Panoramica per gli sviluppatori
Questo documento è la pagina di orientamento per gli sviluppatori e gli integratori che lavorano con ADP Car Market Hub. Rimane deliberatamente a un livello generale. I dettagli di implementazione interna, le API private, i dettagli di archiviazione interna e l'infrastruttura di rilascio sensibile dal punto di vista della sicurezza sono gestiti separatamente e non fanno parte della documentazione pubblica.
Quando utilizzare questo documento
Leggi questo documento se sei:
- Un implementatore di siti che ha bisogno di orientamento prima di personalizzare template o impostazioni per una concessionaria specifica.
- Un integratore che collega il plugin a un CRM, a uno strumento di marketing o a un pianificatore esterno tramite le superfici supportate e documentate del plugin.
- Un revisore che valuta il plugin a livello generale prima di consigliarlo.
Gli utenti finali (il personale della concessionaria che configura il plugin dall'amministrazione di WordPress) dovrebbero invece iniziare con le sezioni della documentazione rivolte agli utenti, in particolare il manuale utente e il riferimento amministratore.
Cos'è il plugin
ADP Car Market Hub è un plugin WordPress che importa e sincronizza gli annunci di veicoli da un marketplace a monte in WordPress, ed espone:
- Un catalogo veicoli pubblico (archivio, pagina del singolo veicolo, pagina di confronto, preferiti, filtro di ricerca).
- Un'area di amministrazione per la configurazione, le importazioni e la gestione dei lead.
- Un piccolo set di shortcode documentati e template sovrascrivibili dal tema su cui gli integratori possono fare affidamento.
Il plugin richiede le versioni di WordPress e PHP dichiarate nell'intestazione del plugin stesso. Viene fornito con traduzioni integrate per le lingue supportate e offre un percorso pulito di attivazione, disattivazione e disinstallazione.
Come navigare in questa sezione
- Per la configurazione dell'ambiente, vedi Local Development Setup.
- Per le convenzioni di scrittura del codice, vedi Coding Standards.
- Per le superfici di integrazione supportate, vedi Shortcodes For Developers e Template System And Overrides.
- Per i contributi alle traduzioni, vedi Internationalization For Developers.
- Per il processo di contribuzione, vedi Contribution Guidelines.
Altre pagine in questa sezione forniscono un riepilogo sicuro per il pubblico di aree (architettura, archiviazione, REST/AJAX, cron, sicurezza, rilascio, analytics, Market Insights, ecc.) i cui dettagli interni non sono deliberatamente pubblicati.
Superfici di integrazione pubbliche supportate
Quando ti integri con il plugin, preferisci queste superfici stabili:
- L'interfaccia utente delle impostazioni di amministrazione del plugin.
- Gli shortcode documentati.
- Le sovrascritture dei template a livello di tema come descritto in Template System And Overrides.
- La Panoramica per gli sviluppatori generale per l'orientamento.
I nomi delle classi interne, le chiavi delle opzioni, le tabelle del database, gli endpoint REST e AJAX, i nomi degli hook cron, gli identificatori di capability e nonce e l'infrastruttura di rilascio / aggiornamento sono trattati come dettagli di implementazione. Possono cambiare tra i rilasci senza preavviso e non fanno parte del contratto di integrazione pubblico.
Politica di stabilità e modifiche
Tutto ciò che non è elencato come superficie pubblica supportata sopra è considerato un dettaglio di implementazione interna. Le API interne, il layout di archiviazione e l'implementazione della sicurezza possono variare tra i rilasci. Non dipendere da essi da codice di terze parti, temi o sistemi esterni. Le scritture dirette nel database non sono supportate.
Avviso sulla documentazione pubblica. Questa pagina fornisce solo una panoramica di integrazione ad alto livello. I dettagli di implementazione interna, le API private, i dettagli di archiviazione interna e l'infrastruttura di rilascio sensibile dal punto di vista della sicurezza sono gestiti separatamente e non fanno parte della documentazione pubblica. Le superfici di integrazione supportate sono gli shortcode documentati, le sovrascritture dei template, l'interfaccia utente delle impostazioni e qualsiasi punto di estensione esplicitamente pubblicato in questa sezione.