Digital Distribution Web Services (DDWS) GetMyPrice - Manuale di servizio

Transcript

1 Digital Distribution Web Services (DDWS) GetMyPrice - Manuale di servizio

2 INDICE 1 Introduzione Panoramica Supporto di documenti Guida introduttiva Panoramica del servizio GetMyPrice Informazioni dettagliate su GetMyPrice Vantaggi del servizio GetMyPrice Informazioni di riferimento del servizio GetMyPrice Schema di richiesta Schema di risposta Schema di errore Messaggi di richiesta Messaggi di risposta Messaggi di errore Codici e messaggi di errore Esempio di risposte di errore... 9 Cronologia revisioni Versione Data Autore Commenti /22/2015 AR Aggiunta della sezione Cronologia revisioni /03/2015 AR Correzione per la visualizzazione di "Facoltativo" nel campo Quantità della sezione /22/2015 AR Aggiornamento dei messaggi di risposta nella sezione /16/16 PL Aggiornamento dei codici di errore e dei messaggi nella sezione Manuale di riferimento del servizio Web

3 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. In un 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 Guida per lo sviluppatore partner di Autodesk: tale guida consente ai partner di eseguire il processo di formazione e accedere ai servizi DDWS. Consente inoltre di presentare ai partner la piattaforma di servizi digitali Autodesk, tramite istruzioni dettagliate per l'esecuzione delle attività iniziali necessarie per l'integrazione. Documentazione sull'api di autenticazione: tale documento consente ai partner di eseguire il processo di generazione di credenziali, firme e token di accesso necessari per l'utilizzo delle API di servizio. Contiene inoltre informazioni per lo sviluppo di un'applicazione di integrazione del 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 Manuale di riferimento del servizio Web

4 3 Panoramica del servizio GetMyPrice 3.1 Informazioni dettagliate su GetMyPrice Il servizio GetMyPrice ha lo scopo di consentire le seguenti operazioni: 1. Fornire Disti/DVAR al prezzo di acquisto 2. Fornire il prezzo di vendita consigliato ai partner non diretti 3. Durante la creazione dell'ordine (tramite PlaceOrder), fornire il prezzo che il partner paga su tale ordine a) Ad esempio, in caso di aggiunta a un contratto esistente, il prezzo sull'ordine potrebbe dover essere ripartito proporzionalmente. 3.2 Vantaggi del servizio GetMyPrice 1. Un servizio Web REST semplice che può essere utilizzato facilmente da qualsiasi applicazione tramite connessione HTTP. 2. Fornisce i prezzi corretti per partner e SKU. 3. Consente di inserire e convalidare gli ordini 4. Migliora la qualità dei dati recuperando in tempo reale le informazioni sui prezzi. 4 Manuale di riferimento del servizio Web

5 4 Informazioni di riferimento del servizio GetMyPrice 4.1 Schema di richiesta Lo schema di richiesta per GetMyPrice include i seguenti campi di input. I campi part_number, customer_number e price_date devono essere inclusi in una richiesta del partner, insieme a una delle seguenti combinazioni dei campi rimanenti: 1) Nessuno dei campi. 2) agreement_number 3) opportunity_number 4) quantity 5) agreement_number, quantity 6) opportunity_number, quantity Nome campo Tipo di campo Lunghezza/Formato input Utilizzo part_number STRING Lunghezza max. 17 Obbligatorio customer_number INT lunghezza == 10 Obbligatorio opportunity_number STRING N/D Facoltativo agreement_number INT lunghezza == 12 Facoltativo price_date DATA Formato: ISO 8601 AAAA-MM-GG Obbligatorio quantity INT Lunghezza max. 13 Facoltativo 4.2 Schema di risposta Nome campo Descrizione status_code Codice corrispondente al tipo di stato status Risposta di conferma: "OK", "NON RIUSCITO", "ERRORE" message Condivide il tipo di prezzo response Importo prezzo 4.3 Schema di errore Nome campo Descrizione status Risposta di conferma: "OK", "NON RIUSCITO", "ERRORE" status code Codice corrispondente allo stato visualizzato message Messaggio in caso di errore message_code Codice corrispondente allo specifico messaggio di errore visualizzato error_message Spiega la causa dell'errore response. Vuoto a causa dell'errore. 5 Manuale di riferimento del servizio Web

6 4.4 Messaggi di richiesta Di seguito sono disponibili esempi di richiesta corrispondenti a diverse combinazioni di parametri. 1) Valid call to get price using only mandatory headers GET request URL -- stg.autodesk.com/v1/sku/prices?part_number=769f T169&customer_number= &price_date= &quantity=1 2) Valid call to get price using the price date T169&customer_number= &price_date= &quantity=1 3) Valid call to get price with agreement number and price date T169&customer_number= &agreement_number= &price_date= &quantity=1 4) Valid call to get price with opportunity number and price date T169&customer_number= &opportunity_number=A &price_date= &quantity=1 6 Manuale di riferimento del servizio Web

7 4.5 Messaggi di risposta Di seguito sono disponibili esempi di messaggi di risposta corrispondenti agli esempi di richiesa precedenti. 1) Valid call to get price using only mandatory headers "status_code": 200, "status": "OK", "message": "NetPrice", "response": "net_price": 954.8, "currency": "USD", "formatted_net_price": "$954.80" 2) Valid call to get price with agreement number and price date "status_code": 200, "status": "OK", "message": "ProratedNetPrice", "response": "net_price": , "currency": "USD", "formatted_net_price": "$3,053.23" 3) Valid call to get price with opportunity number and price date "status_code": 200, "status": "OK", "message": "AcePrice", "response": "net_price":224.3, "currency": "USD", "formatted_net_price": "$224.30" 7 Manuale di riferimento del servizio Web

8 4.6 Messaggi di errore La tabella seguente include alcuni esempi di codici di errore e dei relativi messaggi di errore presenti nei messaggi di risposta quando viene rilevato un errore: Codici e messaggi di errore Di seguito sono disponibili i codici e i messaggi di errore relativi al servizio. Numero del messaggio UAN-GEN UAN-GEN UAN-GEN UAN-GEN UAN-GEN UAN-GEN APG-DWS-INV-002 Messaggio di errore Il numero cliente è obbligatorio. Numero cliente non valido. Verificare il valore e riprovare. Specificare una combinazione di parametri validi Specificare i nomi dei parametri corretti Immettere il numero SKU Il numero dell'ordine deve includere 10 caratteri. Verificare il valore e riprovare. Il numero cliente fornito non è valido. Inserire un valore opportunity_number valido. 8 Manuale di riferimento del servizio Web

9 4.6.2 Esempio di risposte di errore 1) Customer number required Response: "status_code": 400, "status": "Error", "message": "error_code": "UAN-GEN-00108", "error_message": "customer_number is required", "response": 2) Customer number length validation "status_code": 400, "status": "Error", "message": "error_code": "UAN-GEN-00123", "error_message": "customer_number is limited to 10 characters", "response": 3) Partner Number validation "status_code": 400, "status": "Error", "message": "error_code": "UAN-GEN-00108", "error_message": "Please enter SKU number", "response": 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'utilizzo, la divulgazione o la distribuzione non autorizzati sono vietati. 9 Manuale di riferimento del servizio Web