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

Transcript

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

2 INDICE 1 Introduzione Panoramica Supporto di documenti Guida introduttiva Panoramica del servizio GetInvoice GetInvoiceList GetInvoiceDetails Vantaggi del servizio GetInvoice Informazioni di riferimento del servizio GetInvoice Nota sui CSN multipli Schema di richiesta Schema di risposta GetInvoiceList GetInvoiceDetails Schema di errore Messaggio di richiesta Messaggio di richiesta - GetInvoiceList Messaggio di richiesta - GetInvoiceDetails Messaggio di risposta Messaggio di risposta - GetInvoiceList Messaggio di risposta - GetInvoiceDetails Messaggi di errore Esempi di risposta di errore Appendice Codice C# per l'immissione di più CSN Programma principale Classe Utils POCOs Manuale di riferimento del servizio Web

3 Cronologia revisioni Versione Data Autore Commenti /22/2015 AR Aggiunta della sezione Cronologia revisioni /14/2015 AR Aggiunta dei campi adsk_vat_number, recurring_po, total_amount sotto invoice_header per la risposta GetInvoiceDetails nella sezione /22/2015 AR Sostituzione della lunghezza massima di purchase_order_number con 35 caratteri nella sezione /23/2016 RL Aggiunta dei campi bill_per_start_dt e bill_per_end_dt in invoice_items /23/2016 ER Aggiornamento della descrizione per contract_end 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 di 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. 3 Manuale di riferimento del servizio Web

4 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 Panoramica del servizio GetInvoice Possono verificarsi scenari nei quali il richiedente inserisce un intervallo di date (dal/al). In tal caso, il servizio non è in grado di fornire tutti i dettagli della fatturazione per un determinato periodo di tempo, poiché è possibile che in un periodo di tempo specifico qualsiasi sia presente un numero elevato di fatture. Nel servizio sono disponibili due operazioni per il recupero delle fatture: getinvoicelist getinvoicedetails Il servizio getinvoice è descritto nel diagramma qui sopra. Implementando la piattaforma di servizi digitali Autodesk è possibile rendere i processi più efficaci. Nei grafici che seguono viene illustrata l'esperienza di un utente con Web Store. 4 Manuale di riferimento del servizio Web

5 Nella prima immagine viene descritta la richiesta di un'operazione getinvoicelist. Per ottenere le fatture relative a un determinato periodo di tempo, il cliente deve indicare un intervallo di date. In base al valore immesso, verranno visualizzate tutte le fatture relative all'intervallo indicato. Dopo aver ottenuto l'elenco delle fatture, il cliente può visualizzare i dettagli di un determinato numero di fattura, numero di ordine di acquisto o numero di ordine di vendita, come illustrato nell'immagine seguente. 3.1 GetInvoiceList Lo scopo di questa operazione è ottenere l'elenco delle fatture da un sistema back-end se il valore immesso include solo un intervallo di date. Una volta che il richiedente riceve la risposta, può richiedere getinvoicedetails inserendo il nmero di fattura, il numero di ordine di acquisto o il numero di ordine di vendita. Per richiedere il servizio, è necessario immettere i seguenti valori: 5 Manuale di riferimento del servizio Web

6 1. customer_number 2. invoice_date_from 3. invoice_date_to 3.2 GetInvoiceDetails Lo scopo di questa operazione è ottenere i dettagli della fattura in base a un determinato input. L'operazione può essere richiesta utilizzando i seguenti gruppi di input: 1. customer_number e purchase_order_number/invoice_number/sales_order_number Se i 3 parametri (po_number, invoice_number e order_number) sono tutti presenti nella richiesta del servizio, allora la priorità dei criteri di ricerca verrà definita come segue: 1. invoice_number (alta) 2. purchase_order_number 3. sales_order_number (bassa) Nota: verrà compilata solo una fattura valida come parte della risposta dell'api di GetInvoice. 3.3 Vantaggi del servizio GetInvoice 1. Un servizio Web REST semplice che può essere utilizzato facilmente da qualsiasi applicazione tramite connessione HTTP. 2. La possibilità di recuperare all'occorrenza le informazioni di fatturazione da parte dei partner, eliminando la necessità di cercare fatture in formato PDF nelle o nei dati EDI IDoc. 3. Il servizio offre ai partner la possibilità di eseguire ricerche di fatture in un determinato intervallo di tempo o tramite il numero della fattura, il numero di ordine di acquisto o il numero di vendita 4. I partner possono personalizzare i dati delle fatture e collegarli al proprio sistema interno. 4 Informazioni di riferimento del servizio GetInvoice 4.1 Nota sui CSN multipli Il servizio GetInvoice supporta un solo customer_number (CSN) per richiesta. Se un partner dispone di più CSN, dovrà richiedere il servizio più volte per ottenere le informazioni corrispondenti. Per eseguire questa operazione, è possibile programmare nell'applicazione che si connette un loop in grado di richiedere il servizio GetInvoice una sola volta per ciascun CSN disponibile. È importante che tale script gestisca anche la creazione di credenziali e token di accesso per ciascuna richiesta. Un esempio di tale script è descritto nella sezione Appendice del presente Manuale di riferimento del servizio. Di seguito viene riportato il segmento pertinente dell'esempio citato. // Looping through each CSN var container = new List<ResponseContainer>(); foreach (var csn in credentials.csns) // Signing partner's credentials var firstsignature = Utils.GetFirstSignature(credentials); 6 Manuale di riferimento del servizio Web

7 Elementi getiinvoicedetails() Elementi getinvoicelist() // Sending request to OAuth server to generate an Access Token var tokendetails = Utils.CallOAuthEndPoint(firstSignature); credentials); // Signing Access Token var secondsignature = Utils.GetSecondSignature(tokenDetails, // Calling Get Invoice WebService var endpoint = string.format(" stg.autodesk.com/v1/invoices?customer_number=0&invoice_date_from= &invoice_date_to= ", csn); var invoice = Utils.GetInvoices(endPoint, secondsignature, csn); // Storing WebService's response var invoicecontainer = JsonConvert.DeserializeObject<InvoiceContainer>(invoice); container.add(new ResponseContainer CSN = csn, Response = invoicecontainer ); // Writing response to file var json = JsonConvert.SerializeObject(container, Formatting.Indented); Utils.WriteJsonToFile(json); 4.2 Schema di richiesta I dettagli dei parametri del messaggio di richiesta sono elencati nella tabella seguente per getinvoicelist () e getinvoicedetails(). Elemento customer_number Tipo di campo String Lunghezza/Formato input Lunghezza: max 10 caratteri Utilizzo Obbligatorio Invoice_date_from Data Formato: ISO 8601 AAAA-MM-GG Obbligatorio invoice_date_to Data Formato: ISO 8601 AAAA-MM-GG Obbligatorio customer_number String Lunghezza: max 10 caratteri Obbligatorio invoice_number purchase_order_number sales_order_number String String String Lunghezza: max 10 caratteri Lunghezza: max 35 caratteri Lunghezza: max 10 caratteri Uno o tutti possono essere passati con il valore customer_number 7 Manuale di riferimento del servizio Web

8 4.3 Schema di risposta GetInvoiceList Nome campo Descrizione invoice_number Numero di fattura bill_to_customer Numero cliente 1 purchase_order_number Numero dell'ordine di acquisto del cliente invoice_date Data di pubblicazione nel documento Formato: ISO 8601 AAAA-MM-GG transaction_type Descrizione del tipo di documento invoice_total_amount Importo nella valuta del documento invoice_currency Codice valuta account_doc_description Testo dell'elemento customer_po_number Numero dell'ordine di acquisto del cliente sales_order_number Numero documento di vendita e distribuzione GetInvoiceDetails Nome campo invoice_number name bank_keys bank_number bank_branchid bank_account_number currency alternative_bank_account lockbox_number swiftcode iban bank_control_key country address city district region postalcode tel_number fax_number additional invoice_date invoice_number Descrizione invoice_bankinfo Numero documento di vendita e distribuzione Nome della banca Codici bancari Numero di banca Filiale Numero di conto bancario Valuta della banca Numero di conto bancario alternativo (per numeri di conto ambigui) Numero LockBox Codice SWIFT per pagamenti internazionali IBAN (numero di conto bancario internazionale) Codice di controllo bancario Paese Indirizzo della banca Città Distretto Regione (stato, provincia, contea) Codice postale/casella postale N. di telefono N. di fax Ulteriori informazioni (ABI/CAB/GIRO/Sort Code e cosìvia). invoice_header Data di fatturazione per l'indice di fatturazione e la stampa Formato: ISO 8601 Numero documento di vendita e distribuzione 8 Manuale di riferimento del servizio Web

9 po_date Data dell'ordine di acquisto del cliente Formato: ISO 8601 order_date Data dell'ordine di vendita Formato: ISO 8601 AAAA-MM-GG purchase_order_number Numero dell'ordine di acquisto del cliente customer_po_number Numero dell'ordine di acquisto del destinatario della spedizione transaction_type Char 20 ship_date Data Formato: ISO 8601 AAAA-MM-GG invoice_currency Valuta del documento SD sales_order_number Ordine contract_number Riferimenti interni del cliente o del venditore payment_term Termini di pagamento payment_due Scadenza del pagamento Formato: ISO 8601 AAAA-MM-GG local_currency Codice valuta exchange_rate Tasso di cambio per la determinazione dei prezzi vat_number Partita IVA delivery_code Incoterms (parte 1) delivery_description Incoterms (parte 2) delivery_number Consegna numbers_item Numero naturale tax_amount Importo dell'imposta nella valuta del documento tax_type Tipo di imposta tax_rate Aliquota imposta freight_charge Spese di trasporto tracking_number Numero di bolla di accompagnamento opportunity_id ID Opportunità extra_po_identifier Identificatore di acquisto aggiuntivo invoice_amount Valore netto nella valuta del documento weight_total Peso totale weight_uom Unità di peso reserve_header_field Campo intestazione backup adsk_vat_number Partita IVA Autodesk recurring_po Ordine di acquisto per gli ordini con abbonamento ricorrente total_amount Valore netto + tasse invoice_items invoice_number Documento di fatturazione line_number Articolo fatturato sku Numero materiale sku_description Testo breve per elemento ordine di vendita physical_media Valore ELD da valore CHAR invoice_currency Valuta del documento SD 9 Manuale di riferimento del servizio Web

10 contract_start Data di inizio del contratto Formato: ISO 8601 AAAA-MM-GG contract_end Data di fine del contratto Formato: ISO 8601 AAAA-MM-GG Per gli ordini ricorrenti (mensili e annuali), vengono applicate le seguenti regole. Se il contratto è stato annullato, il campo contract_end contiene la data di annullamento. Se il contratto è attivo, il campo contract_end contiene il testo "Rinnovo automatico del contratto". quantity Quantità effettiva fatturata quantity_uom Unità di misura di base seats Numero naturale unit_price Prezzo unitario unit_discount Sconto unitario net_value Valore netto dell'articolo fatturato nella valuta del documento serial_number Numero di serie current_serial_number Numero di serie corrente old_serial_number Numero di serie precedente partner_subs_id Fil partner # vat_description Testo IVA reserve_item_field Campo elemento backup bill_per_start_dt Data di inizio del periodo di fatturazione bill_per_end_dt Data di fine del periodo di fatturazione invoice_partners invoice_number Numero documento di vendita e distribuzione line_number Articolo fatturato partner_type Tipo di cliente partner_number Numero cliente 1 contact_number Numero della persona di contatto partner_name Nome street Via e numero civico po_box Casella postale city Città postal_code CAP pobox_postal_code Codice postale/casella postale country Nome paese tel_number Numero di telefono principale fax_number Numero fax district Distretto region Regione (stato, provincia, contea) country_iso Codice ISO nazionale 10 Manuale di riferimento del servizio Web

11 4.4 Schema di errore Nome campo status message transactionid Descrizione Risposta di conferma: "OK", "NON RIUSCITO", "ERRORE" Messaggio in caso di errore ID di transazione univoco (combinazione del numero di fattura e del timestamp) 4.5 Messaggio di richiesta In base ai parametri immessi, viene richiesta l'operazione getinvoicelist() o getinvoicedetails(). Se il valore immesso contiene i parametri "dal" e "al", verrà richiesto getinvoicelist(). Se nella voce immessa sono presenti il numero dell'ordine di acquisto, il numero della fattura o il numero dell'ordine di vendita, verrà richiesto getinvoicedetails(). Di seguito sono disponibili richieste di esempio per entrambe le operazioni Messaggio di richiesta - GetInvoiceList stg.autodesk.com/v1/invoices?customer_number= &invoice_date_from= &invoice_date_to= Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>> 11 Manuale di riferimento del servizio Web

12 4.5.2 Messaggio di richiesta - GetInvoiceDetails Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>> OR es_order_number= Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>> OR chase_order_number= Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>> OR es_order_number= &purchase_order_number= Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>> 12 Manuale di riferimento del servizio Web

13 4.6 Messaggio di risposta Nota: Autodesk invierà una risposta con la struttura seguente. I partner possono riformattarla utilizzando una struttura diversa in base alle proprie esigenze Messaggio di risposta - GetInvoiceList ] "status": "OK", "transaction_id": "INV ", "message": [ "invoice_number": " ", "purchase_order_number": " ", "bill_to_customer": " ", "invoice_date": " , "customer_po_number": "", "transaction_type": "Invoice", "invoice_total_amount": 328.5, "invoice_currency": "USD", "account_doc_description": "", "sales_order_number": " ", "invoice_number": " ", "purchase_order_number ": " ", "bill_to_customer ": " ", "invoice_date": " ", "customer_po_number ": "", "transaction_type": "Invoice", "invoice_total_amount: , "invoice_currency": "USD", "account_doc_description ": "", "sales_order_number ": " " Messaggio di risposta - GetInvoiceDetails "status": "OK", "transaction_id": "INV ", "message": [ "invoice_bankinfo": [ invoice_number : , "name": "Merghle", 13 Manuale di riferimento del servizio Web

14 , "bank_keys": "", "bank_number": "", "bank_branchid": "", "bank_account_number": "", "currency": "", "alternative_bank_account": "", "lockbox_number": "", "swiftcode": "", iban": "", "bank_control_key": "", "country": "", "address": "", "city": "Carol Stream, IL ", district :, "region": "", "postalcode": "", "tel_number": ", "fax_number ": "", "additional": "MAIL PAYMENTS TO: AUTODESK, INC. C/O MERGHLE" invoice_number : , "name": "Merghle", "bank_keys": "", "bank_number": "", "bank_branchid": "", "bank_account_number": " ", "currency": "", "alternative_bank_account": "", "lockbox_number": "", "swiftcode": "", "iban": "", "bank_control_key": "", "country": "", "address": "", "city": "", district :, "region": "", "postalcode": "", "tel_number": ", "fax_number ": "", "additional": "ABA# /WIRE PAYMENTS TO:" ], "invoice_header": [ "invoice_date": " ", "invoice_number": " ", "po_date": " ", "order_date": " ", "purchase_order_number": "D _R2D2", "customer_po_number": "", "transaction_type": "Invoice", 14 Manuale di riferimento del servizio Web

15 "ship_date": null, "invoice_currency": "USD", "sales_order_number": " ", "contract_number": "D ", "payment_term": "30", "payment_due": "Up to 11/23/2014 without deduction", "local_currency": "USD", "exchange_rate": 1, "vat_number": "", "delivery_code": "CIF", "delivery_description": "FOB Origin", "delivery_number": "", "numbers_of_items": 1, "tax_amount": 0, "tax_type": "TPS;TVQ", "tax_rate": "7.975%;7%", "tracking_number": "1ZR43W ", "extra_po_identifier": "", "freight_charge": 0, "opportunity_id": "", " invoice_amount": 30, "weight_total": 0, "weight_uom": "", "reserve_header_field": "" ], "invoice_items": [ "invoice_number": " ", "line_number": "000050", "sku": "961F1-WW6573-L994", "sku_description": "ADSKFD 2014 TL:MT SUB WW ELD", physical_media :, "invoice_currency": "USD", "contract_start": " ", "contract_end": " ", "quantity": 1, "quantity_uom": "EA", "seats": 0, "unit_price": 30, "unit_discount": 0, "net_value": 30, "serial_number": " ", "current_serial_number": "", "old_serial_number": "", "partner_subs_id": "", vat_description :, "reserve_item_field": "", "bill_per_start_dt": " T00:00: ", "bill_per_end_dt": " T00:00: " ], "invoice_partners": [ 15 Manuale di riferimento del servizio Web

16 ,, "invoice_number": " ", "line_number": "000000", "partner_type": "", "partner_number": "", "contact_number": " ", "partner_name": "Autochair Inc.", "street": "McInnis Parkway", "po_box": "", "city": "SAN ROFFEL", "postal_code": "94903", "pobox_postal_code": "", "country": "USA", "tel_number": " ", "fax_number": "", "district": "MARIN", "region": "CA" "invoice_number": " ", "line_number": "000000", "partner_type": "Sold to", "partner_number": " ", "contact_number": " ", "partner_name": "Quechua Rentals", "street": "410 Terry Ave N", "po_box": "", "city": "Seattle", "postal_code": " ", "pobox_postal_code": "", "country": "USA", "tel_number": "", "fax_number": "", "district": "KING", "region": "WA" "invoice_number": " ", "line_number": "000000", "partner_type": "Bill to", "partner_number": " ", "contact_number": " ", "partner_name": "Quechua Rentals", "street": "410 Terry Ave N", "po_box": "", "city": "Seattle", "postal_code": " ", "pobox_postal_code": "", "country": "USA", "tel_number": "", "fax_number": "", "district": "KING", "region": "WA" 16 Manuale di riferimento del servizio Web

17 ] ],, "invoice_number": " ", "line_number": "000000", "partner_type": "Ship to", "partner_number": " ", "contact_number": " ", "partner_name": "Quechua Rentals", "street": "410 Terry Ave N", "po_box": "", "city": "Seattle", "postal_code": " ", "pobox_postal_code": "", "country": "USA", "tel_number": "", "fax_number": "", "district": "KING", "region": "WA" "invoice_number": " ", "line_number": "000050", "partner_type": "Reseller", "partner_number": " ", "contact_number": " ", "partner_name": "Quechua Rentals", "street": "410 Terry Ave N", "po_box": "", "city": "Seattle", "postal_code": " ", "pobox_postal_code": "", "country": "USA", "tel_number": "", "fax_number": "", "district": "KING", "region": "WA" Nota: in caso di più tipi di imposta e aliquote di imposta, il servizio fornirà i dati nel modo seguente. Qui i valori sono separati da ";" e tax_type e tax_rate verranno forniti in sequenza (ad es., tax_rate 7.975% corrisponde al tipo di imposta "TPS" e tax_rate "7%" corrisponde a tax_type "TVQ") 17 Manuale di riferimento del servizio Web

18 4.7 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 del cliente UAN-GEN Numero cliente con valore vuoto Il campo non può essere vuoto. Immettere la data L'intervallo di date non può superare 90 giorni. Verificare il valore e riprovare. I numeri cliente non possono superare 10 caratteri. Verificare il valore e riprovare Immettere una data valida nel formato AAAA-MM-GG nel campo Dal Immettere una data valida nel formato AAAA-MM-GG nel campo Al Errore di sistema che impedisce l'elaborazione. Riprovare più tardi Il numero della fattura deve contenere 10 caratteri. Verificare il valore e riprovare. Il numero dell'ordine di vendita deve contenere 10 caratteri. Verificare il valore e riprovare. La data della fattura nel campo Dal deve essere precedente a quella del campo Al Il numero cliente fornito non è valido. UAN-GEN UAN-GEN UAN-GEN UAN-GEN UAN-GEN UAN-GEN UAN-GEN UAN-GEN UAN-INV APG-DWS-INV- 002 Da data fattura/a data fattura con valore vuoto Verificare se l'intervallo di date è maggiore di 90 giorni Verificare se il numero cliente contiene più di 10 caratteri Verificare il formato della data Verificare il formato della data Eccezione tecnica Verificare se il numero della fattura contiene più o meno di 10 caratteri Verificare se il numero di ordine di vendita contiene più o meno di 10 caratteri Verificare se la data della fattura nel campo Dal è precedente a quella del campo Al Se il numero CSN inviato dal partner non è valido "status": "OK", "transaction_id": "INV ", "message": [] - Livello di servizio per rispondere con un messaggio vuoto, nel caso la ricerca non restituisca alcun risultato 18 Manuale di riferimento del servizio Web

19 4.7.1 Esempi di risposta di errore "status": "Error", "transactionid": "INV ", "message": [ "error_code": "UAN-GEN-00108", "error_message": "Please enter Customer Number" ] 5 Appendice 5.1 Codice C# per l'immissione di più CSN Di seguito è disponibile uno script di esempio che i partner possono scrivere per immettere più CSN nel servizio GetInvoice. Poiché il servizio GetInvoice può elaborare solo un numero CSN per richiesta, è necessario programmare l'applicazione di conseguenza. Ad esempio, è possibile programmare un loop che esegua una richiesta per ogni CSN fornito, prendendo in considerazione la generazione delle firme e dei token di accesso. Di seguito è disponibile un esempio di codice che consente di eseguire questa operazione Programma principale using System; using System.Collections.Generic; using System.Text; using MultipleInvoiceCallPoC.POCOs; using Newtonsoft.Json; using System.Diagnostics; using System.Threading; namespace MultipleInvoiceCallPoC class Program static void Main(string[] args) //"Acquiring credentials var credentials = new Credentials BasePath = " ConsumerKey = "AbM03alqHyT3uv3D3cYQV0gq8K0kkKNf", ConsumerSecret = "SCqY7IKSoIZ1ZbY5", CSNs = new List<string>() " ", 19 Manuale di riferimento del servizio Web

20 ; " ", " ", " ", " " // Looping through each CSN var container = new List<ResponseContainer>(); foreach (var csn in credentials.csns) // Signing partner's credentials var firstsignature = Utils.GetFirstSignature(credentials); // Sending request to OAuth server to generate an Access Token var tokendetails = Utils.CallOAuthEndPoint(firstSignature); // Signing Access Token var secondsignature = Utils.GetSecondSignature(tokenDetails, credentials); // Calling Get Invoice WebService var endpoint = string.format(" stg.autodesk.com/v1/invoices?customer_number=0&invoice_date_from= &invoice_date_to= ", csn); var invoice = Utils.GetInvoices(endPoint, secondsignature, csn); // Storing WebService's response var invoicecontainer = JsonConvert.DeserializeObject<InvoiceContainer>(invoice); container.add(new ResponseContainer CSN = csn, Response = invoicecontainer ); // Writing response to file var json = JsonConvert.SerializeObject(container, Formatting.Indented); Utils.WriteJsonToFile(json); Classe Utils public class Utils /// Sets up the OAuth URL end-point and headers to be send in the request in order to /// generate the Access Token /// <param name="url">string that contains the OAuth URL end-point</param> 20 Manuale di riferimento del servizio Web

21 /// <param name="firstsignature">class that contains Partner's signed credentials</param> /// <returns>string with a JSON object</returns> public static string GetAccesToken(string url, FirstSignature firstsignature) var request = (HttpWebRequest)WebRequest.Create(url); request.method = "POST"; request.contenttype = "application/json"; request.headers.add("authorization", string.format("basic 0", firstsignature.base64credentials)); request.headers.add("signature", firstsignature.signedsignature); request.headers.add("timestamp", string.format("0", firstsignature.timestamp)); return GetResponse(request); csn) /// Sets up the GetInvoice URL end-point, headers for the request and a particular CSN /// <param name="url">string that contains the GetInvoices end-point</param> /// <param name="secondsignature">class that contains a signed Access Token</param> /// <param name="csn">string that contains CSN</param> /// <returns>string with a JSON object</returns> public static string GetInvoices(string url, SecondSignature secondsignature, string var request = (HttpWebRequest)WebRequest.Create(url); request.method = "GET"; request.contenttype = "application/json"; request.headers.add("authorization", secondsignature.authorization); request.headers.add("csn", csn); request.headers.add("signature", secondsignature.signedsignature); request.headers.add("timestamp", string.format("0", secondsignature.timestamp)); return GetResponse(request); /// Gets a response from an Internet resource /// <param name="request">requet data </param> /// <returns>string with a JSON object</returns> public static string GetResponse(HttpWebRequest request) try var response = (HttpWebResponse)request.GetResponse(); var enc = System.Text.Encoding.GetEncoding("utf-8"); var responsestream = new StreamReader(response.GetResponseStream(), enc); var result = string.empty; result = responsestream.readtoend(); 21 Manuale di riferimento del servizio Web

22 response.close(); return result; catch (Exception e) Trace.WriteLine(e.Message); return string.empty; /// Calls Invoices Endpoint and retrieves a list of invoices /// <param name="firstsignature">class that contains Partner's signed credentials</param> /// <returns>class with access token data</returns> public static AccessToken CallOAuthEndPoint(FirstSignature firstsignature) var url = " var details = Utils.GetAccesToken(url, firstsignature); var tokendetails = JsonConvert.DeserializeObject<AccessToken>(details); return tokendetails; /// Takes Partner's credentials and signs them /// <param name="credentials">class with partner's credentials data</param> /// <returns>class containing partner's signed credentials</returns> public static FirstSignature GetFirstSignature(Credentials credentials) var credtemp = string.format("0:1", credentials.consumerkey, credentials.consumersecret); var firstsignature = new FirstSignature Base64Credentials = Base64Encode(credTemp), Timestamp = GetEpochTimestamp() ; var message = string.format("012", credentials.basepath, credentials.consumerkey, firstsignature.timestamp); firstsignature.signedsignature = GenerateSignature(message, credentials.consumersecret); return firstsignature; /// Takes Access Token and signs it /// <param name="token">class with access token data</param> /// <param name="credentials">class with partner's credentials data</param> /// <returns>classs containing a signed access token</returns> 22 Manuale di riferimento del servizio Web

23 public static SecondSignature GetSecondSignature(AccessToken token, Credentials credentials) var secondsignature = new SecondSignature Timestamp = GetEpochTimestamp(), CSN = credentials.csn, Authorization = string.format("bearer 0", token.access_token) ; var message = string.format("012", credentials.basepath, token.access_token, secondsignature.timestamp); secondsignature.signedsignature = GenerateSignature(message, credentials.consumersecret); return secondsignature; /// Encode string to base64 /// <param name="plaintext">string to be encoded</param> /// <returns>enconded string</returns> public static string Base64Encode(string plaintext) var plaintextbytes = System.Text.Encoding.UTF8.GetBytes(plainText); return System.Convert.ToBase64String(plainTextBytes); /// Decodes base64 string /// <param name="base64encodeddata">string to be decoded</param> /// <returns>decoded string</returns> public static string Base64Decode(string base64encodeddata) var base64encodedbytes = System.Convert.FromBase64String(base64EncodedData); return System.Text.Encoding.UTF8.GetString(base64EncodedBytes); /// Gets Epoch Unix timestamp /// <returns>epoch Unix timestamp</returns> public static int GetEpochTimestamp() return (int)(datetime.utcnow - new DateTime(1970, 1, 1)).TotalSeconds; /// Hashing of the signature using HMACSHA256 /// <param name="message">string with the message to be hashed</param> /// <param name="secret">string with the consumer secret</param> /// <returns>hashed string</returns> public static string GenerateSignature(string message, string secret) 23 Manuale di riferimento del servizio Web

24 var encoding = new System.Text.ASCIIEncoding(); byte[] keybyte = encoding.getbytes(secret); byte[] messagebytes = encoding.getbytes(message); using (var hmacsha256 = new HMACSHA256(keyByte)) byte[] hashmessage = hmacsha256.computehash(messagebytes); return Convert.ToBase64String(hashmessage); /// Prints a JSON object to a file /// <param name="json">string with a JSON Object</param> public static void WriteJsonToFile(string json) using (System.IO.StreamWriter file = new System.IO.StreamWriter(@"C:\temp\json.txt")) file.writeline(json); POCOs namespace MultipleInvoiceCallPoC /// Class used to store Access Token data public class AccessToken public string access_token get; set; public string expires_in get; set; public string token_type get; set; namespace MultipleInvoiceCallPoC.POCOs /// Class used to encapsulate the Partner's credentials data public class Credentials public string BasePath get; set; public string CSN get; set; public List<string> CSNs get; set; public string ConsumerKey get; set; public string ConsumerSecret get; set; 24 Manuale di riferimento del servizio Web

25 namespace MultipleInvoiceCallPoC.POCOs /// Class used to encapsulate the Partner's signed credentials public class FirstSignature public string Base64Credentials get; set; public int Timestamp get; set; public string SignedSignature get; set; namespace MultipleInvoiceCallPoC.POCOs /// Class used to encapsulate a signed Access Token public class SecondSignature public string SignedSignature get; set; public int Timestamp get; set; public string Authorization get; set; public string CSN get; set; namespace MultipleInvoiceCallPoC.POCOs /// Class that represents an Invoice public class Invoice public string invoice_number get; set; public string purchase_order_number get; set; public string sales_order_number get; set; public string bill_to_customer get; set; public string invoice_date get; set; public string transaction_type get; set; public string invoice_total_amount get; set; public string invoice_currency get; set; public string account_doc_description get; set; public string customer_po_number get; set; /// Class used to contain Invoice data retreived from calling GetInvoices end-point public class InvoiceContainer public string status get; set; public string transaction_id get; set; 25 Manuale di riferimento del servizio Web

26 public Invoice[] message get; set; /// Auxiliary class for display purposes used to contain Invoice data for a particular CSN public class ResponseContainer public string CSN get; set; public InvoiceContainer Responseget; set; 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. 26 Manuale di riferimento del servizio Web