Di seguito la struttura delle chiamate jQuery per ottenere i dati dalle API di DataLabo

Tutte le API sono di tipo REST

Le chiamate necessita di un valido token fornito durante il corso. Ogni chiamata senza token restituisce un messaggio di errore.

Elenco API e metodo di chiamata

La chiamata a questa API permette di ricevere informazioni sul proprio token (periodo di validità rimanente).

E' importante sapere se il token è attivo e non scaduto perchè ogni altra chiamata API necessità del parametro token per essere autorizzati a ricevere dati da DataLabo.

Le API REST di DataLabo sono standard perciò possono essere invocate in diversi modi e da diversi strumenti; quello utilizzato nel corso è una chiamata ajax tramite jQuery dependencies. Un esempio di codice è riportato di seguito:


     var apiurlroot = 'http://unibo.datalabo.it';
     var data = { 'token': tokenstring };
     $.ajax({
              url: apiurlroot+'/api/tokeninfo',
              type: "POST",
              contentType: 'application/json',
              dataType: 'json',
              processData: false, 
              data: JSON.stringify(data),
              success: function (result) {
                        [.....]
              },
              error: function (err) {
                        [.....]
              }
     });

            
            

Tutte le API di DataLabo restituiscono una proprietà "header" che indica se la richiesta è andata a buon fine (OK) o male (ERROR).

Le altre proprietà sono variabili, ad esempio la API "tokeninfo" restituisce una "description" in caso di "ERROR" nell'header, mentre restituisce "results" in caso di "OK".

La chiamata a questa API permette di calcolare il numero di paging dei dati richiesti.

La dimensione di restituzione dei files di dati in formato JSON di DataLabo è fissata a 2000 articoli. Questo per evitare una eccessiva mole computazionale al server nonchè una dimensione di download eccessiva.

E' un metodo di restituzione dati standard, e delega le logiche di richiesta dati al sistema chiamante le API.


    var apiurlroot = 'http://unibo.datalabo.it';
    var data = { 'token': tokenstring, 'datestart' : start, 'dateend': end};
    $.ajax({
             url: apiurlroot+'/api/sellingdatacount',
             type: "POST",
             contentType: 'application/json',
             dataType: 'json',
             processData: false,
             data: JSON.stringify(data),
             success: function (result) {
                    [.....]
             },
             error: function (err) {
                    [.....]
             }
    });


            

Come si vede dal codice, deve essere fatta una richiesta alla API "sellingdatacount" inserendo il token, la data di inizio (inclusa) dei dati richiesti e quella di chiusura (esclusa), entrambe in formato dd/MM/yyyy

Verrà restituito nella proprietà ".Data.results" uno scalare che indica il numero di record incluso nell'intervallo dei parametri.