API REST di Woo­Com­mer­ce: come funziona

L’API REST di Woo­Com­mer­ce permette di accedere al pannello ge­stio­na­le del vostro negozio Woo­Com­mer­ce da remoto (ma non solo). Le ope­ra­zio­ni ele­men­ta­ri come “Lettura” o “Scrittura” vengono gestite tramite richieste HTTP. Potete attivare l’API di Woo­Com­mer­ce di­ret­ta­men­te dal back end.

Che cos’è un’API REST?

In un’API REST vengono definite le risorse di un sistema, con le quali si in­te­ra­gi­sce at­tra­ver­so l’ar­chi­tet­tu­ra REST (Repre­sen­ta­tio­nal State Transfers). Un’in­ter­fac­cia di questo tipo rap­pre­sen­ta una delle migliori soluzioni per con­sen­ti­re ai sistemi per il web una facile ed ef­fi­cien­te co­mu­ni­ca­zio­ne tra client e server.

A ogni risorsa vengono assegnati dei parametri utili a de­scri­ver­la e che possono anche essere mo­di­fi­ca­ti. Le ar­chi­tet­tu­re REST sono rea­liz­za­te uti­liz­zan­do il pro­to­col­lo http, all’interno del quale ogni risorsa può essere iden­ti­fi­ca­ta at­tra­ver­so un URI univoco (Uniform Resource Iden­ti­fier). I parametri vengono fissati come parametri URL e la gestione delle risorse avviene at­tra­ver­so azioni HTTP standard come GET, POST, PUT e DELETE.

A cosa serve un’API REST in Woo­Com­mer­ce?

La ca­rat­te­ri­sti­ca più im­por­tan­te di un’API in Woo­Com­mer­ce per gli accessi REST è la sua uni­ver­sa­li­tà. Infatti, l’API è stata svi­lup­pa­ta in maniera tale da con­sen­ti­re una facile in­te­ra­zio­ne in rete dei negozi Woo­Com­mer­ce con altri siti web o servizi. Di questa versatile in­te­rat­ti­vi­tà con altre ap­pli­ca­zio­ni web ne be­ne­fi­cia­no non soltanto gli svi­lup­pa­to­ri ma anche tutti gli utenti della piat­ta­for­ma Woo­Com­mer­ce, come di­mo­stra­no i seguenti esempi relativi ai vantaggi di utilizzo dell’API di Woo­Com­mer­ce:

• Accesso mul­ti­piat­ta­for­ma: si può accedere da ap­pli­ca­zio­ni terze di­ret­ta­men­te alla dashboard di Woo­Com­mer­ce? Con l’API REST sì e in maniera molto facile.
• In­te­gra­zio­ne facile della logica di business: i software e gli hardware specifici per il business come i wearable o i di­spo­sti­vi di lo­ca­liz­za­zio­ne dell’IoT possono essere integrati nel progetto sem­pli­ce­men­te grazie all’API REST di Woo­Com­mer­ce.
• Ot­ti­miz­za­zio­ne della sin­cro­niz­za­zio­ne dati: le imprese che vogliono sin­cro­niz­za­re il negozio Woo­Com­mer­ce con i dati di diverse piat­ta­for­me e canali, trovano nell’API REST l’in­ter­fac­cia giusta per farlo.
• In­di­pen­den­za dal back end di Woo­Com­mer­ce: con l’at­ti­va­zio­ne dell’API uni­ver­sa­le di Woo­Com­mer­ce vi rendete in­di­pen­den­ti dal back end di Woo­Com­mer­ce e di WordPress. Potete integrare e iniziare a usare la vostra in­ter­fac­cia ge­stio­na­le in qualsiasi momento.
• In­te­gra­zio­ne semplice dei dati di fornitori terzi: con l’in­ter­fac­cia REST avete co­mo­da­men­te accesso ai dati delle ap­pli­ca­zio­ni di fornitori terzi.
• Col­le­ga­men­to con app mobile: collegare il vostro negozio Woo­Com­mer­ce con un’app mobile diventa si­gni­fi­ca­ti­va­men­te più semplice grazie a questa versatile in­ter­fac­cia.

Guida all’utilizzo dell’API REST di Woo­Com­mer­ce

Se volete usare l’API di Woo­Com­mer­ce per l’in­te­ra­zio­ne con altre ap­pli­ca­zio­ni web e servizi dovete per prima cosa attivarla generando una chiave API. Dopodiché dovete in­stal­la­re un client per l’accesso REST. Qui di seguito abbiamo riassunto per voi i singoli passaggi da eseguire.

Primo passaggio: generare la chiave per l’API REST di Woo­Com­mer­ce

Per poter usare l’API REST di Woo­Com­mer­ce, la prima cosa da fare è generare una chiave API. Questa chiave rap­pre­sen­ta una sorta di controllo degli accessi e sarà suc­ces­si­va­men­te uti­liz­za­ta da Woo­Com­mer­ce per au­ten­ti­ca­re le richieste REST.

Per generare una chiave dovete:

1. Accedere al back end di Woo­Com­mer­ce (WordPress).
2. Aprire la scheda “Woo­Com­mer­ce” nel menu laterale di sinistra.
3. Cliccare su “Im­po­sta­zio­ni”.
4. Passare alla scheda “Avanzato”.
5. Se­le­zio­na­re la sezione “API REST”.
6. Cliccare su “Aggiungi chiave” o “Crea una chiave API”.

Close

Dovete impostare tre ca­rat­te­ri­sti­che per la chiave: nel campo “De­scri­zio­ne” riportate una breve spie­ga­zio­ne utile a ri­co­no­sce­re la chiave. Nel campo “Utente” se­le­zio­na­te l’utente Woo­Com­mer­ce per il quale state generando l’accesso all’in­ter­fac­cia. Nel campo “Permessi” stabilite se l’utente ha soltanto uno tra i permessi di lettura e scrittura o se, invece, gli vengono assegnati entrambi.

Una volta fatto, con­fer­ma­te il tutto con un clic su “Genera chiave API”. Woo­Com­mer­ce crea due sequenze di caratteri al­fa­nu­me­ri­ci (Chiave utente e Utente nascosto) e un codice QR. Copiate entrambe le chiavi e salvatele in un documento. Ne avrete bisogno più tardi, quando vorrete accedere all’API Woo­Com­mer­ce con un client REST.

Close

Secondo passaggio: scaricare il client API

Non appena avete generato la chiave, potete inviare le vostre richieste all’in­ter­fac­cia del sistema Woo­Com­mer­ce. Il requisito per farlo è un client API con il quale ef­fet­tua­re la richiesta e vi­sua­liz­za­re la risposta.

Tra i client più comuni per l’accesso REST troviamo Insomnia e Postman. Entrambi gli strumenti sono di­spo­ni­bi­li come ap­pli­ca­zio­ne desktop per Windows, macOS e Linux. Postman, che abbiamo uti­liz­za­to per questa guida, è anche uti­liz­za­bi­le come ap­pli­ca­zio­ne web di­ret­ta­men­te dal browser.

Per in­stal­la­re e con­fi­gu­ra­re Postman dovete:

1. Aprire la pagina di download di Postman e caricare la versione adatta al vostro sistema operativo.
2. Eseguire il file di setup di Postman con un doppio clic.
3. Creare un account Postman, fornendo un indirizzo e-mail valido, un nome utente e una password. In al­ter­na­ti­va, potete re­gi­strar­vi con un account Google.
4. Fornire le in­for­ma­zio­ni che vi vengono richieste e con­di­vi­de­re il link d’invito ai vostri colleghi (se ne avete bisogno).

Close

Terzo passaggio: inviare una richiesta all’API di Woo­Com­mer­ce

Dopo la con­fi­gu­ra­zio­ne potete ve­ri­fi­ca­re l’accesso all’API REST inviando una prima richiesta. Per farlo, aprite il vostro spazio di lavoro e cliccate su “Create new request”.

Close

Per ef­fet­tua­re una prima prova scegliamo una richiesta GET che ci serve a ricevere dei dati. Questa opzione è impostata in au­to­ma­ti­co in Postman. Nel campo relativo all’indirizzo digitate il seguente indirizzo dopo “GET”:

https://woocommerce-domain.xyz/wp-json/wc/v3/orders

Infine, ag­giun­ge­te i dati per l’au­ten­ti­ca­zio­ne dell’API REST di Woo­Com­mer­ce. Qui bisogna spe­ci­fi­ca­re se l’accesso REST avviene tramite HTTP o HTTPS (rac­co­man­da­to). Spostate il cursore “Au­tho­ri­za­tion” e, nel campo “Type”, se­le­zio­na­te “OAuth 1.0” per HTTP o “Basic Auth” per HTTPS. Dopodiché digitate i codici salvati per chiave utente e utente nascosto. Nel caso di Basic Auth, la chiave deve essere inserita nel campo “Username” e la chiave dell’utente nascosto nel campo “Password”.

Close

Non appena avete terminato la con­fi­gu­ra­zio­ne dell’au­ten­ti­ca­zio­ne, cliccate sul pulsante “Send” per inviare la richiesta. Con l’indirizzo di esempio da noi uti­liz­za­to, la richiesta GET serve a ottenere tutti gli ordini in corso. Il risultato viene mostrato da Postman nella finestra sot­to­stan­te nel formato che preferite tra JSON, XML, HTML o testuale.

Close