Come utilizzare le Rest Api in WordPress

Pubblicato in data 2 Agosto 2019 Categoria Consigli WordPress

wordpress rest api

Un’API (Application Programming Interface) è un tipo di software che consente a due applicazioni di collaborare e comunicare scambiando reciprocamente informazioni. Esistono diversi tipi di API che è possibile utilizzare, tra cui le REST (Representational State Transfer). REST API è fondamentalmente un software che consente a due applicazioni di scambiare dati utilizzando un insieme specifico di vincoli. In particolare, le REST API di WordPress consentono di connettere il tuo sito web WordPress con applicazioni esterne. Ciò significa che puoi sviluppare un’app mobile utilizzando praticamente qualsiasi linguaggio di programmazione e utilizzare le REST API per recuperare i dati da WordPress. In un certo senso, le REST API offrono un modo per liberarti dalla struttura intrinseca di WordPress, sfruttandola per aiutarti a creare un’applicazione.

In questo articolo, analizzeremo come funzionano le REST API di WordPress e ti aiuteremo a iniziare da zero.

 

Come funzionano le REST API

In passato, era necessario un plug-in per accedere alle REST API di WordPress ma dalla versione 4.4, sono diventate parte del core. Per utilizzare le REST API, devi semplicemente sapere come interagire con loro, il che si riduce all’utilizzo di quattro diversi tipi di metodi HTTP come parte delle tue richieste:

GET: con questo metodo, puoi recuperare informazioni dal server.
POST:  consente di inviare informazioni al server in questione.
PUT: con il metodo put, è possibile modificare e aggiornare i dati esistenti.
DELETE: Consente di eliminare informazioni.

Considera ad esempio cosa accade quando visiti la tua pagina di accesso di WordPress. Il tuo browser invia una richiesta GET al server, che la elabora utilizzando la propria API. Una volta caricata la pagina, inserisci le tue credenziali e le invii tramite una richiesta POST. Se vuoi cambiare la tua password, implica il metodo PUT, mentre la cancellazione totale del tuo account useresti DELETE.

Ti mostreremo esempi su come utilizzare questi metodi con le REST API di WordPress tra un minuto. Prima però, esaminiamo alcuni altri concetti che devi conoscere.

 

Familiarizza con le REST API di WordPress

Per capire davvero come funzionano le REST API di WordPress, ci sono alcuni concetti che devi conoscere. Quando arriveremo a esempi concreti tra poco, capirai come funziona il tutto.

REST API concetti e termini

Quando usi le REST API di WordPress, visualizzerai sempre gli stessi termini, che sono:

“Routes” e “endpoints“: una route è un URL inserito per effettuare una richiesta, mentre un endpoint è la combinazione di un URL con un metodo HTTP.
Requests : quando si invia un endpoint, si effettua una richiesta al server.
Responses: se il tuo endpoint è strutturato nel modo giusto, otterrai una risposta che include le informazioni che desideri in JavaScript Object Notation (JSON) o un errore.
Schema: ogni risposta che ricevi segue strutture simili, che sono governate da schemi integrati.
Controller classes: puoi utilizzarle per creare percorsi ed endpoints personalizzati, ma questo rientra negli usi più avanzati delle REST API di WordPress.

REST API Endpoints

Nella maggior parte dei casi, utilizzerai route ed endpoints già esistenti per inviare richieste tramite le REST API di WordPress. Conoscere quali sono questi endpoints è il primo passo per padroneggiare le API e utilizzarle per sviluppare i tuoi progetti.

REST API Authentication

Come prevedibile, WordPress non ti consentirà di accedere a determinati dati a meno che non possa confermare chi sei, indipendentemente dal fatto che tu li richieda tramite un browser o le REST API. Se desideri aggiornare o pubblicare un post tramite comandi, dovrai imparare le basi dell’autenticazione.

 

Come iniziare a utilizzare le REST API di WordPress (in 3 passaggi)

Finora abbiamo esaminato molta teoria, quindi è tempo di passare a un piccolo tutorial sull’endpoint di WordPress. In questa sezione, ti mostreremo come accedere alle REST API, recuperare un elenco di dati specifici e aggiungere nuove informazioni utilizzando un endpoint specifico.

Step 1. Accedere alle REST API

Puoi “accedere” alle REST API di WordPress da qualsiasi applicazione in grado di inviare endpoints HTTP. Se ad esempio inserisci il seguente comando nel tuo browser preferito, otterrai un elenco dei tuoi post di WordPress in formato JSON:

GET yourwebsiteurl.com/wp-json/wp/v2/posts

Ovviamente dovrai sostituire l’URL segnaposto con quello del tuo sito web. Dovrai anche utilizzare una versione di WordPress maggiore della 4.4 per far funzionare la richiesta REST API.

Se vuoi davvero sperimentare con le REST API un browser non è lo strumento migliore per farlo. Ti consigliamo invece di utilizzare la riga di comando, che fornisce un approccio più flessibile.

Step 2: recuperare un post specifico utilizzando le WordPress API

L’ultimo comando che hai eseguito avrebbe dovuto restituire un elenco di tutti i post di WordPress, inclusi gli ID dei post. Per recuperare un post specifico utilizzando il suo ID invece, devi utilizzare un endpoint come questo:

GET yourwebsiteurl.com/wp-json/wp/v2/posts/535

Questo sarebbe l’ideale per mostrare un post specifico tradotto all’interno di un’applicazione mobile. Le REST API ti consentono di recuperare ogni tipo di dato da WordPress quindi le sue applicazioni pratiche sono incredibilmente flessibili.

Supponiamo però che tu voglia utilizzare le REST API per aggiungere metadati a un dato post anziché semplicemente recuperarlo. In altre parole, usando il metodo POST invece di GET.

Step 3: aggiungi i metadati a un post specifico

Supponendo che tu abbia già autenticato te stesso, puoi aggiungere nuovi dati a qualsiasi tuo post usando una richiesta simile a quella presentata nell’ultima sezione usando POST invece di GET:

POST yourwebsiteurl.com/wp-json/wp/v2/posts/535/meta?value=newmetadata

Se diversamente si desidera aggiungere metadati per creare un rich snippet per una ricetta, la richiesta dovrebbe essere simile alla seguente:

POST yourwebsiteurl.com/wp-json/wp/v2/posts/535/meta?cookingtime=25

A seconda della quantità di metadati che si desidera aggiungere, è possibile specificarlo utilizzando invece JSON objects, che offre un approccio molto più strutturato. In ogni caso, una volta acquisito familiarità con gli endpoints più comuni e come utilizzarli, si apre un mondo di possibilità.

Per ora è tutto. Le REST API di WordPress sono in circolazione da alcuni anni. Se non l’hai mai usate prima, ci sono molte cose che devi imparare per arrivare al punto  di utilizzarle per sviluppare applicazioni avanzate. Approfondiremo l’argomento con esempi avanzati in un prossimi post del blog.