ezPrint SDK
Page tree

Versions Compared

Old Version 1

changes.mady.by.user Marco Bicchi

Saved on

compared with

New Version Current

changes.mady.by.user Marco Bicchi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 template.
  • productIdeditorType: Tipologia di editor associato alla sessione.
  • productId: Id del prodotto associato alla sessione.
  • projectId: Id del prodotto progetto associato al templatealla sessione.
  • colorPaletteType: Tipologia di palette colore utilizzata nel template.
  • colorPaletteItems:customerId: Id del cliente associato alla sessione.
  • shoppingCartUrl: Url del carrello esterno.
  • shoppingCartExtraParams: Array di stringhe oggetti 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 elementorappresentano i parametri extra che verranno inviati al carrello esterno così composti:
    • paramName: Nome del parametro extra.
    • paramValue: Valore del parametro extra.
  • productEstimationUrl: Url per il calcolo del prezzo.
  • productEstimationExtraParams: Array di oggetti che rappresentano i parametri extra che verranno inviati all'url per il calcolo del prezzo così composti:
    • paramName: Nome del parametro extra.
    • paramValue: Valore del parametro extra.
  • customizeLogoutUrl: Url di logout personalizzato.
  • preFilteredProjects: Array di interi che rappresentano gli id dei progetti visibile all'interno di questa sessione, se vuoto, tutti i progetti sono visibili.
  • verifyProjectNameConflict: true se il sistema verifica durante il salvataggio del progetto che non ci siano progetti con lo stesso nome per lo stesso utente, false in caso contrario.
    languageCode: Codice della lingua preimpostata nella sessione.
  • readyToBuy: true se la sessione fa parte di un processo di acquisto attivo, false in caso contrario.
  • isAlive: true se la sessione risulta collegata ad un editor attivo, false in caso contrario.
  • 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
colourRed
titleAttenzione

Info
titlePossibili tipologie di palette colorisessione

Il campo colorPaletteType sessionType 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 colorpicker0: Sessione per designer.
  • 1: Sessione per cliente.

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

Info
titlePossibili tipologie di editor

Il campo editorType può avere i seguenti valori:

  • 1: PhotoEditor.
  • 2: SmartEditor.

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

 

Code Block
languagephp
titlePHP
linenumberstrue
require "vendor/autoload.php"
 
try {
    $ezPrintSDK = new ezPrintSDKWrapper('http://demo.ezprint.it');
	$apiToken = $ezPrintSDK->cLoginAPI('1WHm0icsupAEm9fil9en','yCHZ0nKiyn1MU0DhpgmG');
 
	$availableLanguages$editorSessions = $ezPrintSDK->backOffice->bGetAvailableLanguages();
	$smartTemplates = $ezPrintSDK->editor->eGetSmartTemplates>eGetActiveEditorSessions(false, false, $availableLanguages[0]['languageId']2, 200false);
	
	foreach($smartTemplates$editorSessions as $template$session) {
        echo $template$session['templateCodesessionHash'], ' ', $template$session['templateNamelanguageCode'];
    }
} catch (Exception $e) {
    echo 'Error Code: ',  $e->getMessage();
}
Code Block
languagejs
titleNode.js
linenumberstrue
try {
	var util = require('util');
	var ezPrintSDK = require('ezprint-sdk-wrapper');
	ezPrintSDK.initializeWrapper('http://demo.ezprint.it');
 
    var apiToken = ezPrintSDK.cLoginAPI('1WHm0icsupAEm9fil9en','yCHZ0nKiyn1MU0DhpgmG');
 
	var editorSessions = ezPrintSDK.editor.eGetActiveEditorSessions(false, false, 2, false);
 
	editorSessions.forEach(function(session) {
        console.log(session.sessionHash);
        console.log(session.languageCode);
    });
} catch (ex) {
	console.log(ex);
}
Code Block
languagec#
title.NET (C#)
linenumberstrue
try {
	ezPrintSDKWrapper.Client ezPrintSDK = new ezPrintSDKWrapper.Client("http://demo.ezprint.it");
	ezPrintSDK.cLoginAPI("1WHm0icsupAEm9fil9en","yCHZ0nKiyn1MU0DhpgmG");
	
	List<ezPrintSDKWrapper.Structures.languageItem> availableLanguages = ezPrintSDK.backOfficeBackOffice.bGetAvailableLanguages();
	var smartTemplatesList<ezPrintSDKWrapper.Structures.sessionEditorItem> editorSessions = ezPrintSDK.editorEditor.eGetSmartTemplateseGetActiveEditorSessions(false, false, availableLanguagesezPrintSDKWrapper.Structures.editorType.smartEditor, false);
 
	System.Console.WriteLine("Editor Session {0}: {1}", editorSessions[0].languageIdsessionHash, 200);
 
	smartTemplates.forEach(function(templateeditorSessions[0].languageCode);
} catch (ezPrintException ex) {
	string ErrorMessage = ex.Message;
}

Descrizione

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

Utilizzo

I parametri richiesti da questa funzione sono:

  • sessionHash: Id della sessione di cui si vogliono ottenere le informazioni, false se non necessario, se impostato annulla gli altri filtri.
  • sessionType: Tipo di sessione di cui si vogliono ottenere le informazioni, false se non necessario.
  • editorType: Tipo di editor di cui si vogliono ottenere 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:

  • sessionHash: Id della sessione.
  • sessionType: Tipologia della sessione.
  • editorType: Tipologia di editor associato alla sessione.
  • productId: Id del prodotto associato alla sessione.
  • 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.
  • productEstimationUrl: Url per il calcolo del prezzo.
  • productEstimationExtraParams: Array di oggetti che rappresentano i parametri extra che verranno inviati all'url per il calcolo del prezzo così composti:
    • paramName: Nome del parametro extra.
    • paramValue: Valore del parametro extra.
  • customizeLogoutUrl: Url di logout personalizzato.
  • preFilteredProjects: Array di interi che rappresentano gli id dei progetti visibile all'interno di questa sessione, se vuoto, tutti i progetti sono visibili.
  • verifyProjectNameConflict: true
    verifyProjectNameConflict

    languageCode: Codice della lingua preimpostata nella sessione.
  • readyToBuy: true se la sessione fa parte di un processo di acquisto attivo, false in caso contrario.
  • isAlive: true se la sessione risulta collegata ad un editor attivo, false in caso contrario.
  • 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
colourRed
titleAttenzione

Info
titlePossibili 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.

Info
titlePossibili tipologie di editor

Il campo editorType può avere i seguenti valori:

  • 1: PhotoEditor.
  • 2: SmartEditor.

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

 

Code Block
languagephp
titlePHP
linenumberstrue
require "vendor/autoload.php"
 
try {
    $ezPrintSDK = new ezPrintSDKWrapper('http://demo.ezprint.it');
	$apiToken = $ezPrintSDK->cLoginAPI('1WHm0icsupAEm9fil9en','yCHZ0nKiyn1MU0DhpgmG');
 
	$editorSessions = $ezPrintSDK->editor->eGetActiveEditorSessions(false, false, 2, false);
	
	foreach($editorSessions as $session) {
        echo $session['sessionHash'], ' ', $session['languageCode'];
    }
} catch (Exception $e) {
    echo 'Error Code: ',  $e->getMessage();
}
Code Block
languagejs
titleNode.js
linenumberstrue
try {
	var util = require('util');
	var ezPrintSDK = require('ezprint-sdk-wrapper');
	ezPrintSDK.initializeWrapper('http://demo.ezprint.it');
 
    var apiToken = ezPrintSDK.cLoginAPI('1WHm0icsupAEm9fil9en','yCHZ0nKiyn1MU0DhpgmG');
 
	var editorSessions = ezPrintSDK.editor.eGetActiveEditorSessions(false, false, 2, false);
 
	editorSessions.forEach(function(session) {
        console.log(templatesession.templateCodesessionHash);
        console.log(templatesession.templateNamelanguageCode);
    });
} catch (ex) {
	console.log(ex);
}
Code Block
languagec#
title.NET (C#)
linenumberstrue
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>sessionEditorItem> smartTemplateseditorSessions = ezPrintSDK.Editor.eGetSmartTemplateseGetActiveEditorSessions(false, false, availableLanguages[0].languageIdezPrintSDKWrapper.Structures.editorType.smartEditor, 200false);
 
	System.Console.WriteLine("SmartEditor TemplateSession {0}: {1}", smartTemplateseditorSessions[0].templateCodesessionHash, smartTemplateseditorSessions[0].templateNamelanguageCode);
} catch (ezPrintException ex) {
	string ErrorMessage = ex.Message;
}