Digital Distribution Web Services (DDWS) Manuale del ... · viene fornito un esempio di...

Digital Distribution Web Services (DDWS) Manuale del servizio GetLicense

2 | Manuale di riferimento dei servizi Web

INDICE Cronologia revisioni ................................................................................................................ 2

1 Introduzione ...................................................................................................................... 3

1.1 Panoramica ............................................................................................................... 3

1.2 Supporto di documenti ............................................................................................... 3

2 Guida introduttiva ............................................................................................................. 3

3 Panoramica del servizio GetLicense ................................................................................ 3

3.1 Limitazioni ................................................................................................................. 4

3.2 Vantaggi .................................................................................................................... 5

4 Informazioni di riferimento del servizio GetLicense .......................................................... 5

4.1 Schema di richiesta ................................................................................................... 5

4.2 Schema di risposta .................................................................................................... 5

4.3 Schema di errore ....................................................................................................... 7

4.4 Messaggio di richiesta ............................................................................................... 8

4.5 Messaggio di risposta ................................................................................................ 9

4.6 Messaggi di errore ................................................................................................... 10

4.6.1 Esempi di risposta di errore .............................................................................. 12

Cronologia revisioni

Versione Data Autore Commenti

2.1.2 2016-10-24 SJ Aggiornati gli URL nella sezione 4.4

2.1.1 2016-07-01 CC Revisione iniziale con contrassegni delle modifiche alla Versione 2


1 Introduzione

1.1 Panoramica

La piattaforma Digital Distribution Web Service (DDWS) è una soluzione automatizzata Autodesk per l'inserimento degli ordini eseguito direttamente dai nostri partner, il tutto con un piccolo intervento dei partner e nessuna azione da parte di Autodesk. Questa nuova funzionalità aziendale consente vere

transazioni di servizi Web B2B tra i partner e Autodesk.

Per fornire ai partner un'implementazione efficace della piattaforma di servizi digitali Autodesk, gli affiliati devono conoscere i servizi Web REST, OAuth e JSON. Nel documento Guida alla programmazione viene fornito un esempio di applicazione client (scritto in linguaggio Ruby) che consentirà agli sviluppatori degli affiliati di utilizzare l'API del servizio digitale.

1.2 Supporto di documenti

Autodesk Partner Developer Guide: questa guida fornisce ai partner informazioni utili per il processo di formazione e l'accesso ai servizi DDWS. Ha inoltre lo scopo di presentare ai partner la piattaforma di servizi digitali di Autodesk mediante istruzioni passo-passo che li guidino durante l'esecuzione delle attività iniziali necessarie per l'integrazione.

Authentication API Documentation: questo documento illustra ai partner il processo di generazione delle credenziali, delle firme e dei token di accesso necessari per utilizzare le API dei servizi. Contiene inoltre informazioni per lo sviluppo di un'applicazione di integrazione di un partner, Fornisce informazioni di base sull'integrazione del servizio Web e illustra lo sviluppo di un'applicazione tipica.

2 Guida introduttiva

Come parte del processo di formazione, i partner verranno associati a un numero CSN (Customer Specific Number) univoco e la loro applicazione verrà registrata presso Autodesk.

Per ulteriori informazioni sul processo di formazione, fare riferimento alla Guida per sviluppatori partner di Autodesk.

3 Panoramica del servizio GetLicense

Questo servizio ha lo scopo di recuperare le informazioni sulle risorse per un determinato numero di serie o per una combinazione di codici di linee di prodotti e numeri di serie. Caratteristiche principali del servizio:


Recupero delle informazioni sulle risorse in base a determinati numeri di serie o

alla combinazione di codici di linee di prodotti e numeri di serie.

Possibilità di convalidare le informazioni sulla licenza prima dell'invio dell'ordine.

Di seguito viene descritta l'implementazione di un esempio di ricerca di risorsa singola. Nota: questa è un'interfaccia utente di esempio

3.1 Limitazioni

Il servizio attuale ha le seguenti limitazioni:

1. Ricerca manuale di risorse o licenze.

2. Imprecisione nelle transazioni.


3. Problemi di integrazione aziendale/EDI.

4. Tempi di elaborazione degli ordini più lunghi.

3.2 Vantaggi

Il servizio GetLicense offre i seguenti vantaggi:

1. Un servizio Web REST semplice che può essere utilizzato facilmente da qualsiasi

applicazione tramite connessione HTTP.

2. Possibilità per i partner di ottenere informazioni sulle risorse con determinati numeri di

serie o fornendo una combinazione di codici di linee di prodotti e numeri di serie.

3. I partner possono ottenere informazioni sulle risorse per più numeri di serie in una

singola richiesta.

4. Ricerca automatica di risorse o licenze.

5. Verifica anticipata delle informazioni sull'ordine.

6. Precisione delle transazioni.

7. Integrazione aziendale più rapida.

8. Accesso diretto alle informazioni dai sistemi ADSK.

9. Tempi di elaborazione dell'ordine più rapidi.

10. Automatizzazione delle query manuali.

4 Informazioni di riferimento del servizio GetLicense

4.1 Schema di richiesta

Elemento Tipo di campo Lunghezza/formato

input Utilizzo

Codice linea di prodotti

Stringa Lunghezza: max 40

caratteri Facoltativo

Numero di serie Stringa Lunghezza: max 12

caratteri Obbligatorio

4.2 Schema di risposta

Nella tabella seguente vengono illustrati i campi di risposta, in base al tipo di partner.


Non distributore/Non rivenditore di dati

Distributore Rivenditore

GetLicenseResponse/License*



contract_number contract_number contract_number

asset_subscription_start_date asset_subscription_start_date asset_subscription_start_date

asset_subscription_end_date asset_subscription_end_date asset_subscription_end_date

contract_end_date contract_end_date contract_end_date

contract_start_date contract_start_date contract_start_date

group_number group_number group_number

euaccountame euaccountame euaccountame

euaccount_number euaccount_number euaccount_number

deployment deployment deployment

description description description

group_name group_name group_name

id id id

license_behavior license_behavior license_behavior

license_type license_type license_type

part_number part_number part_number

product_key product_key product_key

product_line product_line product_line

product_line_code product_line_code product_line_code

registered_date registered_date registered_date

seats seats seats

serial_number serial_number serial_number

status status status

subscription_flag subscription_flag subscription_flag

usage_type usage_type usage_type

ND contact_emailaddress contact_emailaddress

subscription_program_type subscription_program_type subscription_program_type

ND contact_first_name contact_first_name

ND contact_last_name contact_last_name

recent_activation_date recent_activation_date recent_activation_date

licensing_model licensing_model licensing_model

ND contract_term contract_term

ND account_address account_address

relationship_from/relationship




product_name product_name product_name


seats seats seats



relationship_to/relationship relationship_to/relationship relationship_to/relationship


product_name product_name product_name

seats seats seats



Se uno dei serialnumber_productlinecode non esiste, la serie di messaggi conterrà un oggetto JSON per indicare un risultato non trovato. L'oggetto JSON conterrà i campi indicati di seguito.

Non distributore/Non rivenditore di dati

Distributore Rivenditore


error_code error_code error_code

error_message error_message error_message

Di seguito sono riportate le descrizioni visualizzate quando non viene trovato un input serialnumber_productlinecode.

Messaggio di errore Codice di errore Descrizione errore

Numero di serie non trovato nei sistemi Autodesk.

SOA-License-006 Indica che per uno dei numeri di serie specificati non sono stati trovati risultati.

4.3 Schema di errore

Nome campo Descrizione

status Risposta di conferma: "OK", "Error"

message Messaggio in caso di operazione non riuscita o di errori

error_code Codice di errore associato a un messaggio di errore

error_message Descrizione della causa di una risposta di errore

transaction_id ID transazione univoco (combinazione di LIC, numero di serie e timestamp)


4.4 Messaggio di richiesta

Di seguito sono disponibili esempi di richiesta per l'operazione GetLicence. I partner possono ottenere informazioni per più numeri di serie, numeri di serie singoli e combinazioni di numeri di serie e codici di linee di prodotti, come specificato nel seguente esempio di richiesta.

http://enterprise-api-qa.autodesk.com/v2/license?serialnumber_productlinecode=345-99809632,345-99809632|CIV3D Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>> OR http://enterprise-api-qa.autodesk.com/v2/license?serialnumber_productlinecode=345-99809632,345-99809632 Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>> OR http://enterprise-api-qa.autodesk.com/v2/license?serialnumber_productlinecode=345-99809632|CIV3D Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>>


4.5 Messaggio di risposta

{ "status": "OK", "transaction_id": "LIC701765101433844843", "message": [ { "contract_number": "765100009876", "asset_subscription_start_date": "07/16/2016", "asset_subscription_end_date": "Auto-Renewing Contract", "contract_end_date": " Auto-Renewing Contract", "contract_start_date": "06/06/2016 ", "euaccountame": "Panini Adam", "euaccount_number": "5102888078", "deployment": "Standalone", "description": "AutoCAD Civil 3D 2007 English, International", "license_behavior": "Term Extendable", "license_type": "Upgrade", "part_number": "23704-051452-9780", "product_key": "25554", "product_line": "Autodesk AutoCAD", "product_line_code": "CIV3D", "registered_date": "05/19/2007", "seats": "1", "serial_number": "345-99999632", "status": "Registered", "subscription_flag": "false", "usage_type": "Education Market Ready", "list_of_message": null, "relationship_from": { "relationship": [ { "product_name": "autodesk 3dxmax 2016 Non-Language Specific", "seats": "1", "serial_number": "345-99809632", "status": "Upgraded", } ], }, "relationship_to": { "relationship": [ { "product_name": "autodesk 3dxmax 2016 Non-Language Specific", "seats": "1",


"serial_number": "345-99809632", "status": "Registered", } ], }, "contact_emailaddress": "[email protected]", "subscription_program_type": null, "contact_first_name": "Adam", "contact_last_name": "Panini", "licensing_model": null, "contract_term": “A02”, "account_address": "6/8 Newhaven Road, Nowhereshire, EH6 5PU, United Kingdom" } ] }

4.6 Messaggi di errore

La tabella seguente include i codici di errore e i relativi messaggi di errore presenti nella risposta quando viene rilevato un errore:

Messaggio di errore Codice di

errore Descrizione errore

Immettere il numero di serie. UAN-GEN-00108

Questo messaggio di errore viene generato quando il campo Numero di serie è vuoto o contiene il valore Null.

Il numero di serie non può contenere più di 12 caratteri. Verificare il valore e riprovare.

UAN-GEN-00123

Questo messaggio di errore viene generato quando la lunghezza il numero di serie include più di 12 caratteri.

Il numero di serie contiene caratteri non validi. Verificare il valore e riprovare.

UAN-GEN-00119

Questo errore viene generato se il numero di serie è stato inoltrato con caratteri speciali diversi da '-'. Esempio di numero di serie non valido: 341-*%^@#$@#$ADGH


Il formato del numero di serie non è valido. Verificare il valore e riprovare.

UAN-GEN-00119

Questo errore viene generato se nel numero di serie non è presente il carattere '-'. Esempio di numero di serie non valido: 39135980978.

In una richiesta non possono essere inseriti più di 20 numeri di serie.

UAN-LIC-00002

Questo errore viene generato se la richiesta contiene più di 20 numeri di serie.

Il codice della linea di prodotti non può includere più di 40 caratteri. Verificare il valore e riprovare.

UAN-GEN-00123

Questo messaggio di errore viene generato quando la lunghezza del valore del codice della linea di prodotti include più di 40 caratteri.

Il codice della linea di prodotti contiene caratteri non validi. Verificare il valore e riprovare.

UAN-GEN-00119

Questo messaggio di errore viene generato quando il codice di una linea di prodotti contiene il carattere "*".

È stato rilevato un numero di serie duplicato nella richiesta con la combinazione di numero di serie <<numero di serie>> e codice della linea di prodotti <<codice linea di prodotti>>.

UAN-LIC-00001

Questo messaggio di errore viene generato quando la combinazione del numero di serie e del codice della linea di prodotti si ripete nella richiesta.

Errore di sistema che impedisce l'elaborazione. Riprovare più tardi.

UAN-GEN-00122

Questo errore viene generato per qualsiasi errore tecnico.


4.6.1 Esempi di risposta di errore

Nota: il presente Manuale di riferimento del servizio è rivolto ai soli destinatari previsti e può contenere informazioni private e/o riservate che potrebbero essere confidenziali o protette dalla divulgazione. La revisione, l'uso, la divulgazione o la distribuzione non autorizzati sono vietati.

{ "status": "Error", "transaction_id": "LIC50770000001444078583", "message": [ { "error_code": "UAN-GEN-00119", "error_message": "Serial Number is not in valid format. Please check your entry and try again" } ] }

Digital Distribution Web Services (DDWS) Manuale del ... · viene fornito un esempio di...

Documents

Transcript of Digital Distribution Web Services (DDWS) Manuale del ... · viene fornito un esempio di...