REST API di WooCommerce

Le API Rest (Representational State Transfer) di WooCommerce hanno la funzione di sincronizzare dati come ordini, prodotti o altro, con software esterni.

Per una maggiore comprensione della terminologia utilizzata nell’articolo bisogna conoscere i seguenti termini:

  • API: da Application Programming Interface, che indica una serie di procedure generate per portare a termine un compito.
  • RESTful: se Rest è l’architettura del sistema, RESTful è la creazione di processi che utilizzano la filosofia REST.

Cosa sono le API REST di WooCommerce

La logica del REST fu formalizzato da Roy FIelding, e gira intorno all’utilizzo di un’architettura stateless (la comunicazione tra server e client deve contenere tutte le informazioni per essere risolta), client-server (separazione dei compiti o SoC) e Cacheable, ossia che tutte le risposte date al server vengono memorizzate nella cache ed etichettate per poter essere riconosciute e aggiornate.

Vantaggi delle REST API

I vantaggi di questo metodo riguardano alcuni aspetti ben definibili, come:

  • L’indipendenza dai linguaggi: esistono API per WordPress o WooCommerce con PHP ma anche con Python o Node.js.
  • Scalabilità grazie alla separazione client-server: la separazione dei compiti (client-server) rende possibile sviluppare in momenti diversi e selettivamente i diversi componenti sviluppati magati in piattaforme differenti.

Arrivare

Tempo richiesto: 5 minuti.

Attivazione delle REST API di WooCommerce

  1. Crea una chiave REST API

    Vai nel pannello WooCommerce > Impostazioni > API REST per generare una chiave da inserire nelle app esterne per creare una connessione.

  2. (Opzionale) Attiva API REST legacy

    Sebbene siano ormai deprecate e a breve disabilitate completamente a favore delle versioni v2 e v3, alcuni vecchi collegamenti potrebbero richiedere le API REST legacy. Per attivarle basta andare su WooCommerce > Impostazioni > API legacy e spuntare la casella.

  3. Genera una nuova chiave

    Clicca Crea una chiave API, inserisci un nome identificativo per la API generata, seleziona un account per segnalare quale utente ha generato la chiave, ed infine seleziona le autorizzazioni concesse (leggi, modifica, o leggi e modifica).

  4. Utilizza le chiavi generate

  5. Testa gli endpoint delle REST API

    Scarica un software come Postman o Insommia e testa gli endpoint sulla piattaforma desiderata, utilizzando la documentazione ufficiale

Utilità del metodo

Le API di WooCommerce permettono di modificare velocemente da un pannello esterno tutti i parametri degli ordini e dei prodotti presenti sulla piattaforma.

Da un punto di vista dell’organizzazione del lavoro e del tempo speso per terminare con successo le operazioni questo metodo fornisce un ottimo metodo per modificare velocemente un gran numero di e-commerce e prodotti.

Versione V3

La più aggiornata versione delle REST API di WooCommerce hanno dei requisiti di versione del sistema, così sintetizzabili:

Requisiti

Per utilizzare l’ultima versione dell’API REST devi utilizzare:

  • WooCommerce versione 3.5 o più aggiornata;
  • WordPress versione 4.4 o superiore;
  • Bisogna attivare i pretty permalinks su Impostazioni > Permalink in modo che gli endpoint personalizzati siano supportati. I permalink predefiniti non funzionano;
  • Si può accedere alle API sia tramite la versione HTTP del sito che da HTTPS, ma ovviamente si consiglia la versione HTTPS.

Formato delle risposte

Di norma il formato delle richieste e delle risposte è JSON, e le risposte sono formattate nella seguente maniera:

  • Gli ID sono numeri interi;
  • Le date seguono il formato ISO8601;
  • I prezzi e i valori monetari vengono restituiti fornendo i primi due decimali;
  • I campi vuoti sono espressi come “null”.