Documentazione API

Scopo: Tutto ciò che devi sapere sull'integrazione del tuo webshop personalizzato con Sendcloud tramite le nostre API (RESTful). 

Link correlati:

• Riferimento API Sendcloud
• Portale per sviluppatori Sendcloud
• Service point per integrazioni API
• FAQ sulle API Sendcloud 
• Linee guida di integrazione per Marketplace

In Sendcloud offriamo funzionalità e strumenti che aiutano le aziende e-commerce ad automatizzare il processo di spedizione. Le nostre funzionalità completamente scalabili semplificano la vita dei retailer online, sia che tu sia un libero professionista o una start-up, oppure una grande azienda che spedisce migliaia di pacchi al mese in tutto il mondo. 

Integrazione con Sendcloud

Ci sono due modi per collegare il tuo negozio online a Sendcloud:

Integrazioni plug-and-play

Se utilizzi un sistema e-commerce come Shopify, WooCommerce, Lightspeed o Magento, non hai bisogno di competenze di sviluppo per collegare il tuo negozio. Offriamo app e plugin plug-and-play per oltre 80 delle piattaforme e-commerce più popolari, disponibili per il download dal marketplace o dall’app store del tuo sistema.

API Sendcloud

Se hai un negozio online sviluppato su misura che non è ospitato o creato tramite una piattaforma e-commerce, entrano in gioco le nostre API. Un’API consente agli sviluppatori di connettersi e di estrarre componenti chiave del nostro sistema interno per integrarli nel tuo webshop o sistema. Le API Sendcloud sono progettate per coprire ogni fase del processo di spedizione.

Le nostre funzionalità possono essere utilizzate insieme oppure singolarmente, offrendoti la flessibilità di progettare e costruire il tuo flusso di lavoro dall’inizio alla fine. Le nostre API ti danno accesso a un’ampia gamma di opzioni di spedizione nazionali e internazionali dei principali corrieri commerciali e postali europei. 

Documentazione e Riferimento API 

Se sei uno sviluppatore esperto e vuoi integrare rapidamente le nostre API, puoi andare direttamente al nostro Riferimento API oppure accedere alle nostre Collezioni Postman.

Se sei nuovo alle API e vuoi una spiegazione dettagliata di come potrebbe apparire il tuo flusso di elaborazione degli ordini, consulta la nostra Documentazione API. Offriamo guide rapide e tutorial per accompagnarti nei concetti fondamentali, dalla creazione del tuo primo Ordine e spedizione tramite API fino alla creazione della tua prima spedizione e al confronto delle tariffe di spedizione.

Cosa puoi fare con le nostre API?

• Orders API
  L’Orders API ti aiuta a preparare i tuoi ordini per la consegna in modo semplice e flessibile.

• Ship an Order API
  La Ship an Order API è una soluzione completa per creare etichette di spedizione per i tuoi ordini. La spedizione include diversi dettagli chiave, come peso, corriere preferito, paese di destinazione e assicurazione. La Ship an Order API semplifica l’automazione dell’intero processo.

• Shipments API
  Puoi creare e gestire spedizioni in modo programmatico utilizzando la Shipments API. Ti consente di automatizzare l’intero ciclo di vita della spedizione senza intervento manuale nella piattaforma, continuando a utilizzare le tue regole di spedizione e impostazioni predefinite.
  Tutte le spedizioni rimangono visibili nel tuo account Sendcloud, così puoi rivederle, risolvere eventuali problemi o modificarle quando necessario.

• Service Points API
  Integra un selettore di service point nel tuo checkout, accedi a un database globale dei punti di ritiro dei corrieri e consenti ai tuoi clienti di scegliere un luogo di consegna comodo per il loro pacco.

• Returns Portal API
  Consenti ai tuoi clienti di gestire autonomamente i propri resi creando una versione personalizzata del Portale Resi. Puoi combinarla con la funzionalità resi a pagamento per addebitare proattivamente una tariffa di reso quando necessario.

• Tracking API
  Recupera la cronologia completa del tracking di un pacco, dal momento in cui viene annunciato al corriere fino alla consegna a casa del cliente.

• Pick-ups API
  Pianifica un ritiro una tantum con un corriere tramite la Pick-ups API e fai ritirare i tuoi pacchi dal magazzino o dal negozio in una fascia oraria selezionata.

• Dynamic Checkout API
  Aumenta il tasso di conversione offrendo opzioni di consegna next-day, same-day e con data programmata direttamente nel checkout. Configura i metodi di spedizione per zona di consegna nel pannello, quindi utilizza l’API per recuperare i metodi disponibili e mostrarli ai tuoi clienti al checkout.

• Returns API
  Crea resi indipendenti utilizzando la Returns API, anche se il pacco non è stato originariamente spedito tramite il tuo account. Accedi a un database dei metodi di reso disponibili e valida la richiesta di reso prima di generare l’etichetta, aiutandoti a evitare costi inutili se il metodo di reso selezionato non è applicabile. 

Cos’è un’API?

API sta per Application Programming Interface. Un’API consente alle applicazioni di comunicare tra loro tramite il web. Per recuperare dati da un’API, si effettua una “request” in un linguaggio di formattazione come JSON o XML, oppure in un linguaggio di programmazione come Python, verso un server, che restituisce i dati richiesti in una “response”. Le API non sono semplicemente un database: oltre a richiedere dati, puoi aggiornarli, crearli ed eliminarli effettuando richieste API verso endpoint specifici.

Ad esempio, l’API Sendcloud ti dà accesso all’endpoint “Create a Shipment”. Puoi inviare una richiesta a questo endpoint per creare una spedizione nel sistema Sendcloud fornendo le informazioni richieste (indirizzo, opzione di spedizione e altro). Per effettuare una richiesta, devi sapere quali informazioni il nostro server necessita per creare la spedizione. Nel nostro Riferimento API forniamo esempi di request e response, oltre a un elenco dei campi obbligatori e facoltativi che puoi includere.

Perché utilizzare un’API invece di un’integrazione plug-and-play?

Gli sviluppatori utilizzano le API per integrare funzionalità specifiche nel webshop o sistema personalizzato esistente. Collegarsi a Sendcloud tramite API ti consente di personalizzare le nostre funzionalità in base alle esigenze della tua attività e di integrarle con applicazioni di terze parti relative a fatturazione e gestione del magazzino. 

Quando integri Sendcloud tramite API, hai piena flessibilità nel decidere come costruire il tuo flusso di elaborazione ordini e logistica. Puoi scegliere di gestire gli ordini direttamente tramite API oppure importarli nel pannello Sendcloud e gestirli da lì. Poiché la nostra API ti dà accesso alle funzionalità chiave singolarmente, puoi decidere quali utilizzare e integrarle direttamente nel tuo sistema e flusso di lavoro. 

Per iniziare 

Pronto a integrare le API Sendcloud? Prima di iniziare, assicurati di aver creato un account Sendcloud e di aver seguito i passaggi nella nostra guida Per iniziare con Sendcloud.

Dovrai completare i seguenti passaggi prima che la nostra API accetti le tue richieste:

1. Configurare l’indirizzo del mittente e quello di reso (facoltativo)
2. Attivare alcuni corrieri nel tuo account
3. Impostare un metodo di pagamento (obbligatorio prima di poter creare etichette di spedizione). Scopri di più su come Sendcloud ti fattura le etichette di spedizione create qui. 

Facoltativo: Non dimenticare di creare un brand, abilitare le notifiche di tracking e creare il tuo Portale Resi. 

Autenticazione

Sendcloud utilizza Basic Authentication per autenticare le richieste alle nostre API. Dovrai includere una chiave API `Public` e `Private` nell’header di ogni chiamata effettuata a un endpoint Sendcloud. 

Esempio: 

curl “https://panel.sendcloud.sc/api/v2/parcels” --user “YOUR_API_KEY:YOUR_API_SECRET”

Consulta la sezione Authentication del nostro Portale per sviluppatori per ulteriori esempi su come autenticarsi alle nostre API. 

Come ottenere le tue chiavi API

1. Accedi al tuo account Sendcloud e vai su Impostazioni > Integrazioni
2. Trova Sendcloud API nell’elenco delle integrazioni e clicca su Connetti
3. Assegna un nome all’integrazione API (es. “Il mio Webshop”) e clicca su Salva
4. Le tue chiavi API Public e Secret verranno generate automaticamente. Copiale e conservale in un luogo sicuro, quindi includile negli header delle tue richieste. La chiave Public è il tuo “username” per l’autenticazione API, mentre la chiave Secret (Private) funge da “password”. 

Abilitare i Service Point

Nella pagina delle impostazioni di Integrazione, come descritto sopra in Autenticazione, puoi scegliere di abilitare o disabilitare i service point. Per effettuare richieste API al Service Points API, spedire pacchi verso un service point o visualizzare il selettore di service point nel checkout, assicurati di abilitare i service point.

Dopo aver selezionato la casella per abilitare i service point, puoi scegliere i corrieri da includere come metodi di consegna presso service point e cliccare su Salva. 

Creare etichette di test

Puoi testare le nostre API senza preoccuparti di costi imprevisti utilizzando l’opzione di spedizione Sendcloud “Unstamped Letter” ("shipping_option_code": "sendcloud:letter"). Per ulteriori informazioni su come creare etichette di test tramite API, consulta la nostra documentazione.

Domande frequenti

Se hai domande sull’utilizzo delle nostre API, puoi consultare la guida Sendcloud APIs - FAQ

Indirizzi IP da inserire nella whitelist