Importare i dati via API

La API di integrazione sono disponibili per:

  • Ordini
  • Modifiche anagrafica cliente
  • Note cliente
  • Nuovi leads
  • Note leads

Nota

L’import dei dati con l’utilizzo delle API, sostituisce quella basata su file delimitato.

Chiamare le API

Nel seguente esempio, mostriamo come recuperare i dati degli ordini.

Esempio di url da chiamare:

http:////v1/progetti//exportPaginazione/ordini?authKey=&format=&offset=&limit=&count=&lastDateImport=&lastID=&statusExport= 

Le variabili tra le parentesi graffe fino a dipendono dall’installazione e configurazione definita da WEDO Srl pertanto se ancora non in possesso dell’indirizzo esatto si prega di richiederlo tramite apposito ticket.

Vediamo ora il significato delle variabili utilizzabili nella query string:

  • :
    • Chiave di autenticazione che deve essere fornita da WEDO Srl
  • :
    • Può assumere i valori “json” oppure “xml” e serve per specificare il formato dei dati restituiti. Attualmente il formato json è quello consigliato e più utilizzato.
  • , , :
    • può assumere i valori “1” (voglio sapere quanti elementi ci sono da scaricare) oppure “0” (voglio l’elenco dei dati veri e propri); i parametri
    • e sono presi in considerazione solamente nel caso in cui ha valore “0” e rappresentano il limite inferiore e superiore dei dati che si intende richiedere, il loro utilizzo è consigliato nel casi in cui i dati da esportare sono in numero elevato e servono per una sorta di “paginazione” per non sovraccaricare sia il server che il client chiamante effettuando così più chiamate “paginate” invece che una sola.
  • , :
    • Per non richiedere sempre gli stessi dati ad ogni chiamata al web service occorre poter filtrare i dati richiesti e questo può avvenire passando o la data di ultima richiesta dati (lastDateImport) oppure l’ultimo identificativo che è stato richiesto (lastID).
    • Consigliamo l’utilizzo del parametro LastID ma se si vuole utilizzare la data come filtro il parametro deve essere una stringa in formato “yyyy/mm/dd hh:mm:ss”.
  • :
    • Può assumere i seguenti valori: “0” (Attesa di Spedizione) oppure “1” (Export in Corso) oppure “2” (Spedito). Normalmente per questo parametro non deve essere passato alcun valore, per coloro invece che vogliono validare i dati prima di renderli disponibili al web service devono passare il valore “2” e validarli prima all’interno dell’Appmanager.

Esempio di utilizzo

  1. Chiamata dell’API per conoscere l’ultimo ID presente (maxID):
...&format=json&offset=&limit=&**count=1**&lastDateImport=&lastID=&statusExport= 

Questa chiamata restituisce un file json così strutturato:

{ "meta":{ "limit":0, "maxID":345, "offset":0, "total_count":10 }, "cod_progetto":"ic.acme", "last_data_import":null, "last_id":null, "testate":null } 
  1. Chiamata del web service per leggere gli ordini da esportare partendo dall’ultimo ID letto:
...&format=json&offset=&limit=&count=0&lastDateImport=&lastID=345&statusExport= 

AMHelper

Per semplificare l’utilizzo delle API di recupero dei dati, è stata creata un libreria denominata AMHelper.

La codice della libreria è open source e liberamente scaricabile da questo indirizzo AMHelper