Accesso ad API esterne
L'accesso ad API esterne fornisce i dati dei veicoli che vengono importati e sincronizzati all'interno di WordPress.
Vedi la documentazione correlataAPI E WEBHOOK
Integrazione controllata di API e webhook per piattaforme WordPress di veicoli
Scoprite come ADP Car Market Hub si collega a dati esterni dei veicoli, gestisce le credenziali API, espone gli endpoint tecnici, supporta i flussi di webhook e valida una comunicazione di rete sicura.
Panoramica di API e webhook per il plugin WordPress ADP Car Market Hub
Questa pagina riepiloga le interfacce tecniche coinvolte nel collegare ADP Car Market Hub a sorgenti dati esterne e a flussi di integrazione basati su WordPress.
Gestione delle credenziali
Le credenziali autorizzano le richieste API e devono essere memorizzate solo nelle impostazioni protette del plugin.
Vedi la documentazione correlataEndpoint REST e AJAX
Gli endpoint tecnici supportano le operazioni del plugin, i flussi frontend e interazioni controllate nell'amministrazione di WordPress.
Vedi la documentazione correlataFlussi di webhook
La documentazione dei webhook spiega come gestire eventi di integrazione o segnali esterni dove supportato.
Vedi la documentazione correlataDiagnostica e supporto
Test di connessione, log e documenti di risoluzione problemi aiutano a identificare richieste non riuscite, endpoint bloccati o errori di configurazione.
Vedi la documentazione correlataArchitettura di connessione per flussi di API e webhook
Un'integrazione API affidabile dipende da richieste in uscita sicure, credenziali valide, configurazione corretta degli endpoint e gestione osservabile degli errori.
- Sorgente esterna di dati veicoli Fornisce dati strutturati di inventario veicoli tramite accesso API configurato.
- Richiesta API HTTPS Il server WordPress deve essere in grado di raggiungere gli endpoint esterni tramite HTTPS sicuro.
- Autenticazione e credenziali Le credenziali API validano l'accesso e determinano quale inventario può essere recuperato.
- Plugin WordPress ADP Car Market Hub Gestisce configurazione, test di connessione, importazioni ed elaborazione interna.
- Elaborazione delle importazioni Trasforma i dati esterni in record veicolo, metadati e media di WordPress.
- Database e libreria multimediale di WordPress Memorizza contenuti veicolo importati, immagini, impostazioni, log e dati operativi correlati.
- Flussi REST, AJAX e frontend Supportano azioni di amministrazione controllate, interazioni frontend e comportamento di integrazione.
- Log, diagnostica e supporto Aiutano a diagnosticare errori di connessione, problemi di endpoint ed errori di integrazione.
Credenziali API e requisiti di accesso
L'accesso API va configurato con attenzione, perché le credenziali determinano quali dati esterni il plugin può richiedere.
Valori richiesti
- URL base dell'API
- URL del token
- Client ID
- Client Secret
- Seller ID o identificatore di account
- Ambiente API
- Endpoint per il test di connessione, se configurato
Regole di gestione delle credenziali
- Non pubblicare le credenziali nella documentazione
- Non inserire le credenziali nei repository
- Memorizzare le credenziali solo nelle impostazioni protette del plugin
- Limitare l'accesso agli amministratori fidati
- Verificare i permessi dell'account prima di importare
- Ruotare le credenziali quando cambiano gli accessi
- Quando possibile, utilizzare credenziali di staging per i test in staging
Rete, SSL e test di connessione
La maggior parte dei problemi API deriva da richieste in uscita bloccate, credenziali non valide, problemi SSL, URL errati o permessi di account inadeguati.
Sito HTTPS valido
URL API esterno valido
Richieste HTTPS in uscita consentite
Nessun firewall di hosting che blocca le chiamate API
Risoluzione DNS funzionante dal server
Catena del certificato SSL valida
Endpoint del token raggiungibile
URL base dell'API raggiungibile
Credenziali inserite correttamente
Accesso al venditore o all'account confermato
Test di connessione completato
Log pertinenti esaminati
Superficie API REST e AJAX esposta dal plugin
Il plugin può utilizzare endpoint API REST e azioni AJAX per operazioni di amministrazione controllate, flussi frontend e comportamenti di integrazione.
Endpoint API REST
Tecnico
La documentazione dell'API REST descrive la superficie degli endpoint del plugin, il comportamento atteso e i limiti tecnici di utilizzo.
- Namespace dell'endpoint
- Scopo della richiesta
- Contesto di autenticazione
- Risposte attese
- Gestione degli errori
- Controlli di sicurezza
Azioni AJAX
Tecnico
La documentazione AJAX descrive interazioni controllate di amministrazione o frontend che si basano sul comportamento AJAX di WordPress.
- Scopo dell'azione
- Verifiche dei nonce
- Verifiche delle capability
- Validazione dell'input
- Formato della risposta
- Gestione degli errori
Integrazione webhook per flussi event-driven
La documentazione dei webhook spiega come gestire eventi di integrazione o segnali esterni quando supportati dal flusso del plugin.
Casi d'uso dei webhook
Usate i webhook per capire come i pattern di integrazione event-driven possano integrare le importazioni pianificate e le azioni manuali.
Integrazione webhookGestione dei webhook
La gestione dei webhook deve validare la sorgente della richiesta, sanitizzare l'input, registrare i fallimenti ed evitare di esporre dati privati.
Documentazione tecnica dei webhookRisoluzione problemi dei webhook
Le chiamate webhook fallite vanno diagnosticate attraverso log, raggiungibilità degli endpoint, controlli di autenticazione e validazione del payload.
Risoluzione problemiDisponibilità e comportamento dei webhook dipendono dalla versione del plugin installata e dallo scenario di integrazione configurato.
Regole di sicurezza e operative per le integrazioni API
Le integrazioni API e webhook devono essere documentate e gestite senza esporre dati sensibili.
Buone pratiche di integrazione
- Utilizzare HTTPS per tutte le comunicazioni esterne
- Limitare l'accesso alle credenziali agli amministratori autorizzati
- Validare gli URL API prima di importare
- Utilizzare credenziali di staging per i test, dove disponibili
- Monitorare le richieste API fallite
- Esaminare i log senza esporre dati personali
- Documentare solo il comportamento pubblico
Non pubblicare
- Client secret
- Token API
- URL API privati
- Dati dei clienti
- Dati personali
- Payload webhook grezzi contenenti dati privati
- Percorsi server interni
- Dettagli implementativi sensibili dal punto di vista della sicurezza
Risoluzione e diagnostica dei problemi di API e webhook
Quando la comunicazione API o webhook non funziona, partite da test di connessione, credenziali, regole di rete e log.
| Problema | Causa probabile | Verifica consigliata | Documentazione |
|---|---|---|---|
| Il test di connessione non riesce | URL errato, richiesta in uscita bloccata o problema SSL | Verificare URL API, DNS, firewall di hosting e catena SSL | API, rete e SSL Errori di connessione API |
| L'autenticazione non riesce | Client ID, client secret, endpoint del token o permessi di account non validi | Verificare le credenziali e l'accesso all'account venditore | Configurazione delle credenziali API Credenziali API esterne |
| Le importazioni non restituiscono veicoli | Seller ID, mapping dell'account o permessi API non corrispondono all'inventario atteso | Verificare l'accesso all'account e la configurazione dell'importazione | Configurazione dell'API AutoScout24 |
| Webhook non ricevuto | Endpoint non raggiungibile o mittente esterno non configurato | Verificare URL webhook, autenticazione e log | Integrazione webhook |
| La richiesta AJAX non riesce | Problema di nonce, permessi o richiesta malformata | Controllare console del browser, permessi di amministrazione e log | Azioni AJAX |
| La richiesta REST non riesce | Problema di autenticazione, capability o endpoint | Verificare namespace dell'endpoint, metodo della richiesta e risposta | Endpoint API REST |
Riferimenti per sviluppatori sugli endpoint di API e webhook
Gli sviluppatori possono utilizzare la documentazione tecnica per esaminare comportamento degli endpoint, punti di estensione, gestione delle richieste e limiti di integrazione.
API REST per sviluppatori
Riferimento tecnico per gli sviluppatori che si integrano con la superficie API REST del plugin.
API REST per sviluppatoriAzioni AJAX per sviluppatori
Documentazione per sviluppatori sulla gestione delle azioni AJAX, dei nonce e dei controlli di capability.
Azioni AJAX per sviluppatoriEndpoint API REST
Riferimento tecnico per tutti gli endpoint REST esposti dal plugin.
Endpoint API RESTAzioni AJAX
Riferimento tecnico per tutte le azioni AJAX registrate dal plugin.
Azioni AJAXWebhook
Documentazione tecnica sul comportamento dei webhook e sui pattern di integrazione.
WebhookSicurezza e controlli di capability
Pattern di sicurezza, controlli di capability e controllo degli accessi per gli endpoint del plugin.
Documentazione per sviluppatoriSanitizzazione ed escape
Pattern di sanitizzazione dell'input ed escape dell'output utilizzati nell'intera codebase del plugin.
Documentazione per sviluppatoriLogging e debug
Strumenti di logging, output di debug e diagnostica disponibili per gli sviluppatori.
Documentazione per sviluppatoriGuida ai test
Indicazioni sui test e flussi di quality assurance per le integrazioni del plugin.
Documentazione per sviluppatoriDocumentazione di API e webhook nel repository pubblico
Aprite direttamente nel repository pubblico i documenti rilevanti su API, webhook, rete e sviluppo.
Guida all'integrazione
Primi passi e requisiti
Documentazione tecnica
Documentazione per sviluppatori
- API REST per sviluppatori
- Azioni AJAX per sviluppatori
- Sezione documentazione per sviluppatori
- Sezione di troubleshooting
I link della documentazione seguono la lingua attiva del sito. L'inglese è la lingua sorgente. Le altre cartelle di lingua utilizzano nomi di cartella e file localizzati.