Magento API / Web Services

Collega Qapla’ con Magento

La connessione avviene tramite i Web Service ufficiali di Magento.
Per permettere a Qapla’ di comunicare con il tuo Magento, è necessario eseguire i passaggi indicati in seguito.

1. Creazione di un Ruolo

Dal pannello di amministrazione di Magento seleziona: Sistema / Servizi Web / SOAP/XML-RPC – Ruoli.

 

Clicca su «Aggiungi Nuovo Ruolo» e nomina come “Tutto”.

Clicca su «Risorse ruolo», seleziona “Tutto”, ed in seguito, clicca su «Salva Ruolo».

2. Creazione di un Utente

Una volta creato il nuovo Ruolo è necessario creare l’Utente.

Dal pannello di amministrazione di Magento selezionare: Sistema / Servizi Web / SOAP/XML-RPC – Utenti.

Clicca su «Aggiungi Nuovo Utente» e compila come segue, utilizzando come API Key Privata la stringa che si trova in Qapla’ andando su:
Impostazioni > Canali > [ Nome Canale ] > Configura > Canale.

N.B. Il nome utente DEVE essere “qapla” senza apostrofo.

Clicca su «Salva Utente».

3. Aggiungere l’Utente al Ruolo

Clicca su «Ruolo utente», seleziona “Tutto”, ed in seguito, clicca su «Salva Utente».

 

4. Verifica WS-I Compliance

Seleziona: Sistema / Configurazione / Magento Core API.

Verifica che i seguenti campi siano specificati come segue:

  • WS-I Compliance = No
  • Abilita Cache WSDL = Sì

Clicca su «Salva Config.»

5. Permessi di lettura per permettere l’importazione ordini

I seguenti permessi di lettura sono quelli minimi che Qapla’ necessita per integrarsi con Magento.

6. Permessi di scrittura per permettere l’aggiornamento ordini

In seguito i permessi di scrittura minimi che Qapla’ necessita per integrarsi con Magento.

7. Inserisci i dati su Qapla’

Su Magento la configurazione è terminata.

Accedi in Impostazioni > Canali > [Nome Canale] > Configura > E-Commerce, seleziona la piattaforma e riporta Username e Store ID di Magento.

Dopo l’inserimento, clicca su «Salva es esegui test».

8. Attivazione dell’importazione ordini

Per attivare l’importazione degli ordini accedi alla sezione: Impostazioni > Canali > [Nome Canale] > Configura > Importazioni > Ordini
Seleziona la modalità di importazione desiderata:

  • Automatica: Qapla’ interrogherà la tua piattaforma ogni ora (alle .00, es. 9:00, 10:00, 11:00, ecc.) per importare nuovi ordini e aggiornare quelli già presenti.
  • Manuale: puoi avviare l’importazione in qualsiasi momento dalla sezione Etichette, selezionando Magento e cliccando su Importazione manuale.

Stati esclusi dall’importazione
Puoi escludere dall’importazione specifici stati ordine (oltre a quelli esclusi di default), personalizzando così il flusso in base alle tue esigenze operative.

Impostazioni Avanzate
All’interno della sezione “Importazioni > Ordini” puoi attivare le seguenti opzioni:

  • Importa immagini dei prodotti
  • Importa il peso

Pre-assegnazione corrieri
È possibile importare automaticamente il corriere scelto su Magento in fase di checkout. Tuttavia, nel caso di Magento, questa configurazione richiede alcune attenzioni specifiche, poiché la piattaforma non restituisce codici corriere strutturati via webservice.
A differenza di altre piattaforme (es. PrestaShop), Magento non fornisce un identificativo univoco del corriere via API, ma trasmette due campi testuali generici:

  • “shipping_method”, esempio: tablerate_bestway
  • “shipping_description”, esempio: Corriere espresso

Il campo “shipping_description” rappresenta la descrizione visibile al cliente in fase di checkout, e non è un codice univoco, ma una semplice stringa. Questo valore può variare nel tempo, in base alla configurazione del merchant su Magento.
Più metodi di spedizione (shipping_method) possono corrispondere a corrieri diversi, e non sempre è possibile distinguere con certezza il corriere effettivamente selezionato.

Poiché si tratta di testi liberi, l’interpretazione del corriere corretto richiedere una mappatura specifica.
Per configurare correttamente questa funzione:

  1. Analizza alcuni ordini reali presenti sulla tua piattaforma Magento (puoi usare Qapla’ Checker), così da verificare i valori presenti nel campo “shipping_description”.
  2. In base a quanto rilevato, sarà possibile procedere all’inserimento nel campo Codice transcodifica nella sezione di configurazione corriere. Se desideri associare più stringhe è possibile inserirli separati da virgola, senza spazi. Esempio: “Corriere espresso,Spedizione standard,Corriere GLS”
  3. Scrivere a support@qapla.it per completare la configurazione, inviando il nome del canale, tutti i codici e il corriere a cui associarli.
    Alla successiva importazione, gli ordini saranno associati al corriere corretto.
    Si consiglia di verificare l’effettiva importazione e l’assegnazione corretta del corriere su uno o più ordini dopo il salvataggio della configurazione, per assicurarsi che la mappatura dei valori sia corretta.

Imposta il peso di default
Imposta un peso predefinito da applicare agli ordini importati.

Imposta il numero di colli di default
Definisci un numero predefinito di colli per ciascun ordine importato

9. Aggiornamento dell’ordine su Magento

Per attivare l’aggiornamento automatico su Magento accedi alla sezione: Impostazioni > Canali > [Nome Canale] > Configura > Aggiornamenti > E-commerce
Abilita le opzioni di aggiornamento disponibili:

  • Complete
    • Aggiorna l’ordine in “Complete” quando la spedizione è partita.
    • Aggiorna l’ordine in “Complete” quando la spedizione è stata ritirata dal corriere.
    • Aggiorna l’ordine in “Complete” quando la spedizione è consegnata.
  • Tracking number: Aggiorna le spedizioni su Magento inserendo il Tracking Number.

10. Attivazione dell’importazione spedizioni

Per attivare l’importazione delle spedizioni accedi alla sezione: Impostazioni > Canali > [Nome Canale] > Configura > Importazioni > Spedizioni > Connectors > Magento Connector > Imposta Connector.
All’interno di questa sezione, imposta l’orario in cui Qapla’ eseguirà l’importazione delle spedizioni da Magento.

  • È possibile configurare fino a due orari per canale
  • Se desideri impostare più di due orari, contatta il nostro customer care scrivendo a support@qapla.it

L’importazione verrà eseguita automaticamente agli orari configurati.

Non funziona?

Qapla’ utilizza le API (Web Services) ufficiali di Magento.

Detti servizi sono preinstallati e funzionanti in tutte le installazioni corrette di Magento fino alla 1.9.X.

Se non dovesse funzionare si consiglia di richiedere la verifica al gestore che amministra il sito su Magento.

For SOAP to work within the Magento application, the PHP SOAP extension ("soap.so") needs to be installed on the server. For RPM-based Linux distributions this is normally installed with the command "yum install php-soap". Note that the PHP SOAP extension is not the same thing as the PEAR SOAP extension

Attenzione: versione 1.9.3.0

Un noto bug affligge questa versione.
A questo indirizzo la fix necessaria.

Script per auto test

Disponibile nel seguente link, uno script che utilizza i Web Services Ufficiali di Magento, utile per eventuali test interni:
https://github.com/qapla-it/php-check-Magento-Web-Service

Troubleshooting

Errore Descrizione Soluzione
401 Unauthorized Qapla’ non è autorizzato ad accedere La key fornita non è corretta o non è stata autorizzata seguendo la procedura spiegata sopra.
403 Forbidden Il server vieta l’accesso a Qapla’ Verificare che il sito non abbia attive delle strategie di sicurezza (Firewall) e accertarsi che gli IP di Qapla’ siano autorizzati.
Per richiedere l’elenco completo ed aggiornato degli IP, contatta la nostra assistenza scrivendo alla mail support@qapla.it.
404 Not Found La url o l’endpoint al quale si prova ad accedere non esiste Verificare la correttezza della url del sito e confermare che il sito sia davvero un Magento.
500 Internal Server Error Errore interno del server del sito Verificare la causa sul proprio server.
Bad HTTP response Il sito non è raggiungibile La url del sito è errata, non è online o non è più esistente.
301 Moved Permanently L’url del sito redireziona ad un’altra Inserire la corretta url del sito.
302 Found L’url del sito redireziona ad un’altra Inserire la corretta url del sito.
Could not resolve host: www.xxx.xx La url non è esistente Inserire la corretta url del sito.
OpenSSL SSL_connect: Connection reset by peer in connection to www.xxx.xx:443 Problemi con il certificato del sito Verificare il certificato https del sito.

In generale le connessioni ai server rispondono con codici di errore HTTP.

Moduli in Magento

Il Modulo al momento non fornisce supporto.
E’ consigliato utilizzare i Web Service ufficiali di Magento.

 

scopri-di-piu-su-qapla