Admin.api e apiVersion

Admin.api(method, request, function(response) { … })

Chiama un metodo delle API e ne ritorna la risposta.

Parametro Descrizione
method Nome completo del metodo.
request Richiesta con i parametri per il metodo. Indicare null se non sono presenti parametri.
response Risposta del metodo.

Le chiamate alle API da JavaScript sono asincrone, ossia la funzione Admin.api() ritorna immediatamente e in seguito quando la chiamata del metodo si conclude verrà chiamata la callback, ossia la funzione passata come terzo parametro. Si possono eseguire più chiamate una dopo l'altra senza attendere che le precedenti siano terminate in quanto Open2b le accoda e le esegue una dopo l'altra.

Se non è importante conoscere la risposta e l'esito dell'esecuzione è possibile omettere la callback.

Esempio

Il seguente è un esempio di chiamata con JavaScript del metodo commerce.products.update per aggiornare un prodotto:

Admin.api('commerce.products.update', {
    id : 496,
    product : {
        isVisible: true,
        name: { it: 'Nuovo nome', en: 'New name' },
    }
}, function(response) {
    if ( response.status != 'ok' ) { alert('Error: '+response.error.description); return; }
    // done
});

Admin.apiVersion

La funzione Admin.apiVersion è una variante della funzione Admin.api che, diversamente da quest'ultima, consente di indicare il numero di versione delle API da chiamare. Admin.api invece chiama sempre la versione 3 che attualmente è l'ultima.

Nota: si consiglia di usare la funzione Admin.api. La funzione Admin.apiVersion andrebbe usata solo se si ha la necessità di utilizzare versioni diverse delle API nella stessa app.

Admin.apiVersion(version, method, request, function(response) { … })

Parametro Descrizione
version Versione delle API da chiamare. Chiamare Admin.getInfo per le versioni disponibili.
method Nome completo del metodo.
request Richiesta con i parametri per il metodo. Indicare null se non sono presenti parametri.
response Risposta del metodo.

Per maggiori dettagli vedere la documentazione di Admin.api.

Quanto ti è stata utile questa pagina?

Grazie per averci aiutato a migliorare questa pagina