ezPrint SDK
Page tree
Skip to end of metadata
Go to start of metadata

Descrizione

Questo metodo può essere utilizzato per ottenere la lista delle categorie del catalogo presenti all'interno del sistema.

Utilizzo

I parametri richiesti da questa funzione sono:

  • categoryId: Id della categoria di cui si vogliono ottenere informazioni, se impostato a false verranno ritornate tutte le categorie presenti nel sistema.
  • languageId: Id della lingua in cui si vogliono ottenere il nome, la descrizione e i metadata della categoria, per le lingue disponibile vedere il metodo getAvailableLanguages.
  • thumbSize: dimensione dell'immagine di preview espressa in pixel (la preview è generata in formato quadrato).

 In caso di successo ritorna un'array di oggetti così strutturati:

  • categoryId: Id della categoria.
  • categoryName: Nome della categoria.
  • categoryDescription: Descrizione della categoria.
  • categoryMetaDataDescription: Descrizione utilizzata dai motori di ricerca.
  • categoryMetaDataKeywords: Parole chiave indicizzate dai motori di ricerca.
  • categoryMasterId: Id della categoria padre (0 = non ci sono categorie padre).
  • categoryImage: Url dell'immagine di preview della categoria.
  • showOnCatalog: true se la categoria è visibile nello shop, false in caso contrario.
  • displayColumns: Numero di colonne in cui vengono suddivise le sottocategorie all'interno dello shop.
  • urlSeo: Se impostato contiene il path di navigazione google Friendly.
  • layouts: Array di oggetti che rappresentano i layout associati alla categoria nei vari store, così strutturati:
    • layoutId: Il del layout.
    • storeId: Id dello store a cui è associato il layout.
  • stores: Array di interi che rappresentano gli id degli store a cui è associata la categoria.
  • enable: true se la categoria è attiva, false in caso contrario.
  • sortOrder: Numero che rappresenta l'indice di visualizzazione per questo elemento.
  • dateCreated: Stringa contenente la data in cui è stata creata la categoria nel formato YYYY-MM-DD HH:MM:SS.
  • dateUpdated: Stringa contenente la data in cui è stata modificata la categoria nel formato YYYY-MM-DD HH:MM:SS.

Gestione errori

In caso di errore il metodo genererà un'eccezione che riporterà uno dei seguenti codici di errore:

  • ERROR_INVALID_PARAMS: Uno dei parametri inviati non è valido.
  • ERROR_INVALID_TOKEN: Non è stato effettuato nessun login in precedenza o la sessione è scaduta per inutilizzo.
  • ERROR_INVALID_IP: L'indirizzo ip del server che sta effettuando la chiamata non valido perchè non inserito nella whitelist associata alle credenziali.
  • ERROR_SERVER_UNAVAILABLE: Il server non è disponibile o si è verificato un errore di comunicazione generico.

 

PHP
require "vendor/autoload.php"
 
try {
    $ezPrintSDK = new ezPrintSDKWrapper('http://demo.ezprint.it');
	$apiToken = $ezPrintSDK->cLoginAPI('1WHm0icsupAEm9fil9en','yCHZ0nKiyn1MU0DhpgmG');
 
	$availableLanguages = $ezPrintSDK->backOffice->bGetAvailableLanguages();
	$categories = $ezPrintSDK->backOffice->bGetCatalogCategories(false, $availableLanguages[0]['languageId'], 100);
	
	foreach($categories as $category) {
        echo $category['categoryId'], ' ', $category['categoryName'];
    }
} catch (Exception $e) {
    echo 'Error Code: ',  $e->getMessage();
}
Node.js
try {
	var util = require('util');
	var ezPrintSDK = require('ezprint-sdk-wrapper');
	ezPrintSDK.initializeWrapper('http://demo.ezprint.it');
 
    var apiToken = ezPrintSDK.cLoginAPI('1WHm0icsupAEm9fil9en','yCHZ0nKiyn1MU0DhpgmG');
 
	var availableLanguages = ezPrintSDK.backOffice.bGetAvailableLanguages();
	var categories = ezPrintSDK.backOffice.bGetCatalogCategories(false, availableLanguages[0].languageId, 100);
 
	categories.forEach(function(category) {
        console.log(category.categoryId);
        console.log(category.categoryName);
    });
} catch (ex) {
	console.log(ex);
}
.NET (C#)
try {
	ezPrintSDKWrapper.Client ezPrintSDK = new ezPrintSDKWrapper.Client("http://demo.ezprint.it");
	ezPrintSDK.cLoginAPI("1WHm0icsupAEm9fil9en","yCHZ0nKiyn1MU0DhpgmG");
	
	List<ezPrintSDKWrapper.Structures.languageItem> availableLanguages = ezPrintSDK.BackOffice.bGetAvailableLanguages();
    List<ezPrintSDKWrapper.Structures.catalogCategoryItem> categories = ezPrintSDK.BackOffice.bGetCatalogCategories(false, availableLanguages[0].languageId, 100);
    
	System.Console.WriteLine("Catalog Category {0}: {1}", categories[0].categoryId, categories[0].categoryImage);
} catch (ezPrintException ex) {
	string ErrorMessage = ex.Message;
}
  • No labels