API - Panoramica

L'API Lengow consente lo scambio di dati tra Lengow e il tuo back office (può essere il tuo back office o un software come Prestashop, Magento ecc...).

Diversi "endpoints" popolano l'API:

  • /orders/

Ricevi tutti i tuoi ordini da qualsiasi marketplace hai impostato in Lengow

  • /orders/actions/
Gestisci e aggiorna i tuoi ordini (accetta ordine, conferma spedizione, annulla…) in base all'elenco degli stati degli ordini accettabili del marketplace.
  • /marketplaces/
Vedi tutti gli stati degli ordini validi del marketplace e le azioni valide che puoi fare su un ordine.
Nessuna azione possibile qui.

Trova di seguito le nostre convenzioni. Queste convenzioni sono scritte per aiutarti a costruire le tue richieste e azioni API.

Esecuzione delle richieste / Codici di risposta HTTP

L'API Lengow fornisce codici di risposta HTTP per ogni richiesta che corrispondono al corpo e all'azione che l'utente ha tentato.

Ecco i codici di risposta più comuni utilizzati dall'API Lengow:

  • Codice 200: OK = Il codice di stato di successo OK HTTP 200 indica che la richiesta è stata eseguita con successo.
  • Codice 201: Creato = La richiesta è stata soddisfatta, è stata creata una nuova risorsa.
  • Codice 202: Accettato = La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è stata completata.
  • Codice 400: Richiesta errata = Il server non può o non elaborerà la richiesta a causa di un apparente errore del client (validazione, URL risorsa errato, ecc).
  • Codice 401: Accesso non concesso = Utilizzato quando è richiesta l'autenticazione e non è riuscita o non è ancora stata fornita.
  • Codice 403: Vietato = La richiesta era valida, ma il server rifiuta l'azione. Nessun permesso per utilizzare la risorsa.
  • Codice 404: Non trovato = La risorsa richiesta non è stata trovata ma potrebbe essere disponibile in futuro.
  • Codice 429: Limite di richieste raggiunto = Sono state fatte troppe richieste in un periodo di tempo troppo breve.
  • Codice 530: Errore logico = La richiesta è fallita probabilmente a causa di parametri di input errati (catalogo che non esiste, regole di ricerca non valide…). Vedi il messaggio di accompagnamento per ulteriori informazioni.
  • Codice 540: Errore tecnico = La richiesta è fallita a causa di un errore interno. Vedi il messaggio di accompagnamento per ulteriori informazioni.
Per ulteriori informazioni, consulta la Lista dei codici di stato HTTP

Intestazioni Content-Type e Accept

Il "Accept" header specifica il formato della richiesta che vuoi ricevere.

In contrasto, l'intestazione "Content-Type" definisce il formato che il chiamante sta inviando all'API. A seconda del endpoint, l'API Lengow supporta un insieme di diversi formati di messaggio.

Se vuoi cambiare il formato dei dati restituiti, puoi impostare l'intestazione Accept . Il server ti risponderà con il formato dato e cambierà l'intestazione Content-Type.

  • Per impostazione predefinita, il formato è “application/json”.

Per ottenere tutti i formati accettati, puoi utilizzare il metodo OPTIONS come di seguito:

/orders/

vai a OPTIONS > headers

Chiave: Accept: application/json"

Cambia chiave con il formato richiesto.

7444a46d-970a-4b42-86de-e0f774bbe052.png

fonte immagine: Postman

Campi data e ora

I campi data e ora sono presentati nel standard ISO-8601 troncato ai secondi con un offset da UTC.

Il formato di data e ora utilizzato per l'API Lengow è elencato di seguito (il nostro esempio è in JSON, e può variare in altri linguaggi di programmazione. Si prega di fare riferimento alla documentazione del vostro linguaggio per ulteriori informazioni).

Formato: yyyy-MM-dd'T'HH:mm:ssXXX

Esempio di output data/ora:

{
"marketplace_order_date": "2019-03-22T17:54:34.369000Z"
}

Prezzi, Valute e Paesi

  • Tutti gli importi monetari come i prezzi sono specificati come numero decimale.

Esempio: 5.50

Esempio : EUR

  • A seconda della risorsa, i paesi sono specificati con due o tre caratteri, come per la convenzione ISO 3166-2.

Esempio: FR

Esecuzione delle richieste / Metodi HTTP

Metodi HTTP supportati:

  • GET
Ricevi dati dall'API.
Esempio: trova l'elenco degli ordini con lo stato "in attesa di spedizione" di Lengow
  • POST
aggiungi nuovi dati. Il metodo POST invia dati al server.
Esempio: Crea una nuova azione di spedizione basata sulle informazioni nel corpo della richiesta, restituisce un corpo di risposta che indicherà la spedizione creata dopo la creazione
  • PUT: sostituisci i dati esistenti
  • PATCH: aggiorna alcuni campi dati esistenti
  • DELETE: elimina i dati esistenti
0c35aff0-3f8e-410d-a64c-eb217de90202.jpg

fonte immagine: Postman

Reindirizzamento HTTPS automatico

Chiusura dei servizi HTTP a favore di HTTPS
Nell'ambito del continuo miglioramento della sicurezza all'interno della nostra piattaforma e per garantire la sicurezza dei vostri dati, il reindirizzamento automatico dei flussi HTTP al protocollo HTTPS non sarà più disponibile a partire dal 1 settembre 2022.

Senza un'azione da parte vostra, si verificheranno interruzioni del servizio senza che i nostri team di supporto possano intervenire sulla risoluzione del problema.

Come mantenere la disponibilità dei nostri servizi?

Per garantire la disponibilità ai nostri servizi dai vostri strumenti, vi consigliamo di controllare e aggiornare le vostre impostazioni. 
A seconda della vostra organizzazione e dell'ambito di azione, potrebbe essere necessario che il vostro reparto tecnico applichi le modifiche.

Dove controllo queste informazioni?

Dipende da come utilizzate la piattaforma Lengow.

  • Se avete strumenti per monitorare i vostri ordini, importare cataloghi o qualsiasi altra informazione in un ERP:

Controllate le impostazioni di questi strumenti. Se le impostazioni del vostro strumento indicano un URL http://api.lengow.io/..., dovete solo sostituire l'"http" con "https" (https://api.lengow.io/...) e salvare la modifica.

  • Se avete impostato URL brevi Lengow su uno o più canali:

Per continuare a esportare i vostri cataloghi ai canali, controllate le impostazioni salvate su ciascuno di essi. Se l'impostazione indicata utilizza il protocollo HTTP (http://feeds.lengow.io/3/...), cambiate l'URL per utilizzare il protocollo HTTPS (https://feeds.lengow.io/3/...)

Dopo aver validato le vostre modifiche, potete controllare che il servizio aggiornato funzioni correttamente. 

Questo articolo è stato tradotto automaticamente. In caso di dubbio, faccia riferimento alle versioni originali in inglese o in francese.

Articoli in questa sezione

I nostri orari di assistenza
Dan Lunedì al Venerdì dalle ore 9:00 alle ore 6:30