Page History

Descrizione

Questo metodo può essere utilizzato per ottenere la lista degli smartTemplate presenti delle sessioni attive all'interno del sistema.

Utilizzo

I parametri richiesti da questa funzione sono:

templateIdsessionHash: Id del template della sessione di cui si vogliono ottenere le informazioni, false se impostato a false verranno ritornati tutti i template presenti.productId: Id del prodotto di non necessario, se impostato annulla gli altri filtri.
sessionType: Tipo di sessione di cui si vogliono ottenere i templatele informazioni, false se non si vuole applicare questo filtronecessario.
languageIdeditorType: Id della lingua in Tipo di editor di 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)le sessioni, false se non necessario.
customerId: Id del cliente di cui si vogliono ottenere le sessioni, false se non necessario.

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

templateIdsessionHash: Id del templatedella sessione.templateCode: Codice del template
sessionType: Tipologia della sessione.
templateName: Nome del template nella lingua richiesta.
templateImage: Url dell'immagine di preview del templateeditorType: Tipologia di editor associato alla sessione.
productId: Id del prodotto associato al templatealla sessione.
colorPaletteType: Tipologia di palette colore utilizzata nel template.
colorPaletteItems: Array di stringhe che contengono i colori presenti nella palette in valori esadecimali #FFFFFF.
presetColorId: Id del preset per i colori impostato nel template, 0 se non presente.
presetFontId: Id del preset per i fonts impostato nel template, 0 se non presente.
googleFonts: Array di interi che contengono gli id dei font google associati a questo template.
adobeTypeKit: Id del kit di adobe associato al template.
enable: true se la categoria è attiva, false in caso contrario.
sortOrder: Numero che rappresenta l'indice di visualizzazione per questo elemento.
projectId: Id del progetto associato alla sessione.
customerId: Id del cliente associato alla sessione.
shoppingCartUrl: Url del carrello esterno.
shoppingCartExtraParams: Array di oggetti che rappresentano i parametri extra che verranno inviati al carrello esterno così composti:
- paramName: Nome del parametro extra.
- paramValue: Valore del parametro extra.
languageCode: Codice della lingua preimpostata nella sessione, false se non necessario, per maggiori informazioni sulle lingue disponibili consultare bGetAvailableLanguages.
dateCreated: Stringa contenente la data in cui è stato creato il template nel formato YYYY-MM-DD HH:MM:SS.
dateUpdated: Stringa contenente la data in cui è stato modificato il template 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.

Status

colour	Red
title	Attenzione

Info

title	Possibili tipologie di sessione

Il campo sessionType può avere i seguenti valori:

0: Sessione per designer.
1: Sessione per cliente.

In .NET è possibile utilizzare la struttura statica editorSessionType presente in Structures.

Status

colour	Red
title	Attenzione

Info

title	Possibili tipologie di palette colori

Il campo colorPaletteType editorType può avere i seguenti valori:

PALETTE: I colori potranno essere scelti da un palette limitata di valori definita nel template.
PICKER: I colori potranno essere scelti trami un colorpicker1: PhotoEditor.
2: SmartEditor.

In .NET è possibile utilizzare la struttura statica colorPaletteTypes editorType presente in Structures.

Code Block

language	php
title	PHP
linenumbers	true

require "vendor/autoload.php"
 
try {
    $ezPrintSDK = new ezPrintSDKWrapper('http://demo.ezprint.it');
	$apiToken = $ezPrintSDK->cLoginAPI('1WHm0icsupAEm9fil9en','yCHZ0nKiyn1MU0DhpgmG');
 
	$availableLanguages = $ezPrintSDK->backOffice->bGetAvailableLanguages();
	$smartTemplates = $ezPrintSDK->editor->eGetSmartTemplates(false, false, $availableLanguages[0]['languageId'], 200);
	
	foreach($smartTemplates as $template) {
        echo $template['templateCode'], ' ', $template['templateName'];
    }
} catch (Exception $e) {
    echo 'Error Code: ',  $e->getMessage();
}

Code Block

language	js
title	Node.js
linenumbers	true

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 smartTemplates = ezPrintSDK.editor.eGetSmartTemplates(false, false, availableLanguages[0].languageId, 200);
 
	smartTemplates.forEach(function(template) {
        console.log(template.templateCode);
        console.log(template.templateName);
    });
} catch (ex) {
	console.log(ex);
}

Code Block

language	c#
title	.NET (C#)
linenumbers	true

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.smartTemplateItem> smartTemplates = ezPrintSDK.Editor.eGetSmartTemplates(false, false, availableLanguages[0].languageId, 200);
 
	System.Console.WriteLine("Smart Template {0}: {1}", smartTemplates[0].templateCode, smartTemplates[0].templateName);
} catch (ezPrintException ex) {
	string ErrorMessage = ex.Message;
}

Page tree

Versions Compared

Old Version 1

New Version 2

Key

Descrizione

Utilizzo

Gestione errori