Nozioni di base sull'API di WordPress: cosa significa e come usarla

Pubblicato: 2016-03-03

Potresti aver sentito il ronzio sull'API REST JSON di WordPress. Questa è una grande notizia per gli utenti di WordPress e motivo di festa!

JSON, REST, API: tuttavia, questo è molto gergo per un nome, quindi analizziamolo tutto.

Che cos'è un'API?

API sta per "interfaccia di programmazione dell'applicazione", che è un insieme di istruzioni e standard di programmazione per l'accesso a un'applicazione software basata sul Web o a uno strumento Web. Immagina il "software uno" che sta dando istruzioni del "software due". Un'API è un accordo tra i due e le linee di comunicazione sono aperte. Fondamentalmente, quello che si dicono l'un l'altro è qualcosa sulla falsariga di "quando mi dai un'istruzione, eseguirò l'azione o restituirò le informazioni corrette".

Quando eseguiamo ricerche sul Web e utilizziamo varie soluzioni software, siamo abituati a interfacce utente con layout, pulsanti e grafici specifici con cui interagiamo per completare le attività desiderate. Tutto questo è inutile per una macchina perché tutto ciò a cui tengono sono i dati, cosa devono fare e come interagiscono con essi. Un'API è l'alternativa del software all'"interfaccia utente", che fornisce istruzioni a un secondo software su come ottenere dati e altre attività specifiche. Sono completamente invisibili agli utenti che utilizzano l'applicazione Web e sono semplicemente un'interfaccia da software a software.

wordpress-api-software-to-software

Esempi di API

Avere accesso a un'API è fantastico quando sviluppi applicazioni web. Quando un'API viene rilasciata al pubblico, significa che gli sviluppatori hanno creato soluzioni basate sul servizio del software. Spesso eliminano la necessità di reinventare la ruota per molti compiti, dal momento che sono già stati creati.

Un ottimo esempio di API è Amazon. Amazon ha rilasciato la sua API in modo che gli sviluppatori possano avere un facile accesso ai prodotti e alle loro informazioni. Avere accesso a questo rende facile pubblicare link a prodotti su Amazon, con prezzi aggiornati e la possibilità di acquistare.

Un altro esempio di interazione tra le API potrebbe essere l'acquisto di biglietti per concerti. Per acquistare ufficialmente i biglietti, devi inserire i dati della tua carta di credito. Un'API viene utilizzata per inviare i dati della tua carta di credito a un'applicazione remota, che quindi verifica che i dati della carta di credito siano corretti. Una volta che tutto è stato verificato, l'applicazione remota invia una risposta al sito Web del biglietto dicendo che è possibile procedere, a quel punto hai acquistato i biglietti con successo. Quando tutto questo sta succedendo, vedi solo un'interfaccia, che è il sito web del biglietto. È un processo continuo; dietro le quinte, molte applicazioni stanno lavorando insieme utilizzando le API, ma tu come utente non ti accorgi quando le attività vengono passate da un'applicazione all'altra.

API e WordPress

Amazon e gli acquisti di biglietti sono ottimi esempi di come le API funzionano insieme, ma come si applica a WordPress?
Bene, tutte le stesse idee si applicano. Con l'API di WordPress, puoi spingere ed estrarre i dati da WordPress.

L'API è uno strumento chiave che gli sviluppatori possono utilizzare per condividere facilmente i dati dal loro sito Web WordPress ad altri siti Web o applicazioni. In particolare, questa API ti consente di eseguire azioni di create , read , update ed delete (CRUD) sui contenuti di WordPress. Alcuni esempi dei tipi di contenuto sono:

  • Messaggi
  • Tipi di post personalizzati
  • Pagine
  • Tassonomie
  • Utenti
  • Media

Cosa significa RIPOSO?

Non ci sono sonnellini o russamenti qui, ma REST si riferisce allo stile architettonico di un'API. REST è l'acronimo di Rappresentational State Transfer. Ricordi come abbiamo detto che un'API fornisce le specifiche per la comunicazione in modo che i programmi possano comunicare tra loro? Le API REST sono progettate in modo tale da fornire un metodo di comunicazione leggero, che consente di risparmiare larghezza di banda. L'API REST JSON di WordPress fa proprio questo, rendendola un'ottima opzione quando c'è un volume elevato di dati.

Abbiamo appena graffiato la superficie di REST; se desideri saperne di più, dai un'occhiata a questo utile tutorial REST.

formato JSON

Per accedere ai dati, abbiamo bisogno di una fonte da cui attingere. È qui che entra in gioco JSON. JSON sta per JavaScript Object Notation. JSON è facile da leggere e capire sia per gli esseri umani che per le macchine. È il modo perfetto per archiviare le informazioni in modo organizzato e di facile accesso. Poiché JSON è così semplice da accedere, questo lo rende perfetto per la creazione di API REST ed è la soluzione perfetta per l'API REST JSON di WordPress.

Ecco un'idea di base di come appare il formato JSON:

{"employees":[
	{"firstName":"Jane", "lastName":"Smith"},
	{"firstName":"Anna", "lastName":"Olsen"},
	{"firstName":"Josh", "lastName":"Jones"}
]}

Formato JSON in WordPress

JSON non si scrive solo da solo, ma non preoccuparti, non devi creare manualmente il file JSON. C'è un ottimo plugin che lo crea per te. Con questo strumento, i dati del sito saranno nel formato corretto, inclusi utenti, post, pagine, tassonomie e altro. Il plugin può essere trovato qui. Inoltre, c'è della documentazione utile che sarà preziosa quando inizierai.

wordpress-api

Utilizzo dell'API REST JSON

L'uso dell'API è abbastanza autoesplicativo; acquisirai i dati del tuo sito in un semplice formato JSON. E se hai installato il plug-in, puoi giocare a vedere i post del tuo sito sotto forma di dati.

Recuperare o aggiornare i dati è semplice come inviare una richiesta HTTP. HTTP è un protocollo di richiesta/risposta. Innanzitutto, invii una richiesta di dati e quindi i dati vengono rispediti come risposta.

Metodo OTTIENI

Il metodo GET viene utilizzato per recuperare informazioni e non ha alcun effetto sui dati. Invia semplicemente una richiesta GET a /wp-json/wp/v2/posts . Vuoi cercare qualcosa? Ad esempio, se stai cercando "sviluppo" otterrai i risultati con la richiesta GET /wp-json/wp/v2/posts?search=development .

Richiesta POST

Una richiesta POST viene utilizzata per inviare dati. Con le funzionalità della nuova API, ad esempio, puoi aggiornare un utente. Supponiamo che tu voglia aggiornare l'utente con l'ID 10. Tutto quello che devi fare è inviare una richiesta POST a /wp-json/wp/v2/users/10 .

Per provarlo, ti consiglio di utilizzare Postman, un'estensione di Google Chrome.

Più Javascript nel mix

Backbone.js e API

Backbone.js è un ottimo modo per lavorare con l'API perché è un framework progettato per lavorare con le API REST. L'API di WordPress include un'API Javascript facile da usare basata su modelli Backbone. Ciò consente agli sviluppatori di plugin e temi di essere operativi senza uno sforzo e una conoscenza super-approfonditi sui dettagli della connessione. C'è molto di più, ma Backbone dà struttura alle applicazioni Web fornendo modelli, raccolte e viste e collega tutto all'API di WordPress tramite un'interfaccia REST JSON.

wordpress-api-backbone

Cosa significa tutto questo per gli sviluppatori di WordPress?

Con la disponibilità dell'API di WordPress, nuovi modi di utilizzarla sono aumentati e continueranno a farlo man mano che guadagnerà popolarità. L'API di WordPress può migliorare praticamente qualsiasi funzionalità WordPress esistente che si basa su Javascript. Ecco alcuni esempi:

  • convalida/invio del modulo
  • Temi o plugin di Backbone.js
  • scorrimento infinito

È anche un ottimo modo per mostrare contenuti da altre fonti. Ora è facile visualizzare il contenuto di un singolo sito all'interno di una configurazione multisito. È anche possibile visualizzare i contenuti da un sito WordPress completamente separato. Oltre a mostrare il contenuto, il contenuto può anche essere aggiornato.

Ora che abbiamo esaminato parte della terminologia di base, sappiamo che JSON è la notazione, REST è lo stile architettonico e API è l'interfaccia che costituiscono. Conoscere le basi dell'API e le sue capacità ti garantirà un buon inizio quando esplorerai le nuove possibilità con l'API di WordPress.