Get Partner Designation Service Reference Manual

Transcript

Digital Distribution Web Services (DDWS)
Manuale del servizio
GetPartnerDesignation
INDICE
Cronologia delle revisioni ...................................................................................................................................... 2
1
Introduzione .................................................................................................................................................... 3
1.1
Panoramica............................................................................................................................................ 3
1.2
Documentazione di supporto ................................................................................................................. 3
2
Operazioni preliminari .................................................................................................................................... 3
3
Panoramica del servizio di designazione dei partner ..................................................................................... 4
3.1
4
Vantaggi del servizio GetPartnerDesignation........................................................................................ 4
Informazioni di riferimento del servizio GetPartnerDesignation ..................................................................... 5
4.1
Schema di richiesta ............................................................................................................................... 5
4.2
Schema di risposta ................................................................................................................................ 5
4.3
Schema di errore ................................................................................................................................... 6
4.4
Messaggi di richiesta ............................................................................................................................. 7
4.5
Messaggio di risposta ............................................................................................................................ 7
4.5.1
Messaggio di risposta - GetPartnerDesignation utilizzando il CSN del rivenditore come input ........ 7
4.5.2
Messaggio di risposta - GetPartnerDesignation utilizzando il codice del paese come input ............ 9
4.6
4.6.1
Messaggi di errore ............................................................................................................................... 11
Esempio di risposta di errore ........................................................................................................... 12
Cronologia delle revisioni
Versione
1.1
Data
02/09/2016
Autore
SJ
Commenti
Versione iniziale
2 | Manuale di riferimento dei servizi Web
1 Introduzione
1.1 Panoramica
La piattaforma Digital Distribution Web Service (DDWS) è una soluzione che consente ai partner di
effettuare automaticamente gli ordini dei prodotti Autodesk e che prevede un'interazione minima ("low
touch") da parte dei partner e nessun intervento ("zero touch") da parte di Autodesk. Questa nuova
funzionalità aziendale aprirà la strada a vere e proprie transazioni basate sui servizi Web B2B tra i partner
e Autodesk.
Perché i partner possano implementare in modo efficace la piattaforma di servizi digitali di Autodesk, le
società affiliate dovranno acquisire familiarità con i servizi Web REST, oAuth e JSON. In una guida alla
programmazione è disponibile un'applicazione client di esempio scritta nel linguaggio Ruby, per
consentire agli sviluppatori delle società affiliate di usufruire dell'API dei servizi digitali.
1.2 Documentazione di supporto
2
•
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 dei servizi Web e illustra lo sviluppo di
un'applicazione tipica.
Operazioni preliminari
Durante il processo di formazione, i partner vengono associati a un Customer Specific Number (CSN)
univoco e le loro applicazioni vengono registrate presso Autodesk.
Per ulteriori informazioni sul processo di formazione, fare riferimento alla Guida per sviluppatori partner di
Autodesk.
3 Panoramica del servizio di designazione dei partner
Le caratteristiche principali del servizio sono:
• Il recupero delle informazioni relative all'account, all'account del contratto e alle competenze in
base al CSN del rivenditore o al paese specificato.
• La convalida del CSN e del CSN del rivenditore specificati. Se la richiesta non è valida, la risposta
restituisce un errore.
3.1 Vantaggi del servizio GetPartnerDesignation
1. Si tratta di un report self-service basato su dati in tempo reale
a. Quando un contratto viene modificato, il report riflette immediatamente tali modifiche
b. Sostituisce i report settimanali attualmente pubblicati nel Partner Center (VAR Spez Report
Dist)
2. Include un servizio Web REST ottimizzato, utilizzabile facilmente da qualsiasi applicazione.
3. Offre ai partner la flessibilità necessaria per ottenere informazioni sulle competenze specificando il
numero CSN di un rivenditore o il codice di un paese.
4 Informazioni di riferimento del servizio GetPartnerDesignation
4.1 Schema di richiesta
La tabella seguente include i dettagli dei parametri del messaggio di richiesta per GetPartnerDesignation.
Elemento
Tipo di campo
CSN
CountryCode
Stringa
Stringa
ResellerCSN
Stringa
Lunghezza/
formato input
10
Codice di paese ISO a
2 cifre
10
Utilizzo
Obbligatorio
Obbligatorio se non
viene specificato il
CSN del rivenditore
Obbligatorio se non
viene specificato il
codice di paese
4.2 Schema di risposta
Per l'invio dell'intervallo di date, verranno visualizzate le colonne indicate di seguito.
Campo
Lunghezza/formato
di output
AccountCSN
Tipo di
campo
Serie di
oggetti
JSON
Stringa
ParentAccountCSN
Stringa
30
AccountName
Stringa
255
Address1
Stringa
255
Address2
Stringa
100
Address3
Stringa
100
City
ZipCode
State
Country
SalesRegion
Stringa
Stringa
Stringa
Stringa
Stringa
50
30
50
50
40
PartnerDesignationList
30
Descrizione
Identificatore univoco per
l'account di un'azienda/un
partner/un cliente finale
Il CSN dell'account principale
nella gerarchia (ad esempio
Domestic Ultimate)
Il nome dell'azienda associato
all'account
L'indirizzo fisico della società
associato all'account
La città del rivenditore
Il codice postale del rivenditore
Lo stato del rivenditore
Il paese del rivenditore
L'area di vendita nel contratto
del partner
10
La data di fine del contratto del
partner
ContractType
Formato
di data
ISO
8601
Stringa
255
PartnerHierachy
PartnerTier
Stringa
Stringa
255
255
Il tipo di contratto in base al tipo
di partner
L'account nella gerarchia
Il livello del partner nel contratto
del partner
ExpertiseList
ExpertiseType
Serie di
oggetti
JSON
Stringa
255
Expertise
Stringa
80
error_code
error_message
Serie di
oggetti
JSON
Stringa
Stringa
13
250
ContractEndDate
Il tipo di specializzazione a cui è
associato il partner
La specializzazione a cui è
associato il partner
Il codice di errore
Il messaggio di errore
4.3 Schema di errore
Nome campo
PartnerDesignationList
Error message
Error code
Descrizione
"null"
Un breve riepilogo che indica l'errore.
Un codice con il formato UAN-SPZ-000XX.
4.4 Messaggi di richiesta
Di seguito sono riportate alcune richieste di esempio per GetPartnerDesignation.
[Getting GetPartnerDesignation using Reseller CSN]
https://enterprise-api-stg.autodesk.com/v1/partnerdesignation?ResellerCSN=1234567890
Message Headers
Content-Type: application/json
Authorization: Bearer <<Access Token>>
CSN: <<CSN>>
signature: <<Signed Access Token>>
timestamp: <<Timestamp for the signed Access Token>>
[Getting GetPartnerDesignation using Country Code]
https://enterprise-api-stg.autodesk.com/v1/partnerdesignation?CountryCode=ME
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
Nota: Autodesk invia una risposta con la struttura seguente. In base alle proprie esigenze, i partner
possono utilizzare strutture di risposta con formati diversi.
4.5.1
Messaggio di risposta - GetPartnerDesignation utilizzando il CSN del rivenditore
come input
{
"PartnerDesignationList": [
{
"ZipCode": "560086",
"State": "KARNATAKA",
"SalesRegion": "INDIA",
"PartnerTier": "Gold",
"PartnerHierachy": "Domestic Ultimate",
"ParentAccountCSN": "5070293421",
"ExpertiseList": [
{
"ExpertiseType": "Specialization",
"Expertise": "AutoCAD"
},
{
"Expertise": "M&E"
},
{
"ExpertiseType": "Product Group",
"Expertise": "Base"
},
{
"Expertise": "Building"
},
{
"Expertise": "Civil Infrastructure"
},
{
"Expertise": "Product Design & Manufacturing"
},
{
"Expertise": "Open"
},
{
"Expertise": "Advanced Structure"
}
],
"Country": "India",
"ContractType": "IVAR",
"ContractEndDate": "2016-01-31",
"City": "Bengaluru",
"Address3": null,
"Address2": "EBIPBCHKGB",
"Address1": "AFAEAFHGDM",
"AccountName": "NHFGGLIOAMKJNNEIELFIGCIBDPOLIEON",
"AccountCSN": "5070293421"
}
],
"error_message": "",
"error_code": ""
}
4.5.2
Messaggio di risposta - GetPartnerDesignation utilizzando il codice del paese
come input
{
"PartnerDesignationList": [
{
"ZipCode": "81000",
"State": null,
"SalesRegion": "Central Europe",
"PartnerTier": "Silver",
"ExpertiseList": [
{
"Expertise": "Base"
},
{
"Expertise": "Civil Infrastructure"
},
{
"Expertise": "Open"
},
{
}
],
"Country": "Montenegro",
"City": "Podgorica",
"Address3": null,
"Address2": "HKIJFOMGJE",
"Address1": "JHOIDNIPME",
"AccountName": "KGGLHLGJLOEEDDJCDGMHMGGLPIOMEBGN",
"AccountCSN": "5101529925"
},
{
"ZipCode": "81000",
"State": null,
"PartnerTier": "Bronze",
"ExpertiseList": [
{
}
],
"Address3": null,
"Address2": null,
"Address1": "NECDGMEGDE",
"AccountName": "OBJAMNAMMKBAJHJKDHJPGCMMDAKAGPKJ",
"AccountCSN": "5104195857"
},
{
"ZipCode": "81000",
"State": null,
"PartnerTier": "Bronze",
"ExpertiseList": [
{
"Expertise": "Base"
},
{
"Expertise": "Open"
},
{
}
],
"Address3": null,
"Address2": null,
"Address1": "HCLKLBBPIB",
"AccountName": "MGFHEAHPMLHLPBHHONCODBPDEEILAOAF",
"AccountCSN": "5106831422"
}
],
"error_message": "",
"error_code": ""
}
4.6 Messaggi di errore
La tabella seguente include i codici di errore con i rispettivi messaggi di errore presenti nei messaggi
di risposta quando viene rilevato un errore:
Numero
messaggio
UAN-SPZ00005
Messaggio di errore
Descrizione dell'errore
Unauthorized CSN
UAN-SPZ00001
The Reseller CSN
provided is not valid
or does not have a
valid Partner Type.
The Country Code is
not valid.
No Active Contracts
found for the CSN.
Please provide
ResellerCSN or
CountryCode.
Missing timestamp on
header.
Missing signature on
header.
Missing CSN on
header.
Missing Authorization
on header.
Invalid Token on
header.
Invalid CSN on
header.
Invalid timestamp on
header.
Invalid signature on
header.
Questo errore viene generato se il tipo di partner del CSN
dell'acquirente inviato dal partner non è "rivenditore principale"
o "distributore".
Questo errore viene generato se il tipo di partner del CSN del
rivenditore specificato non è "rivenditore", "rivenditore
principale", "VCP" o "ISV".
UAN-SPZ00002
UAN-SPZ00003
UAN-SPZ00004
UAN-SPZ04103
UAN-SPZ04102
UAN-SPZ04100
UAN-SPZ04104
UAN-SPZ04303
UAN-SPZ04300
UAN-SPZ04302
UAN-SPZ04301
Questo errore viene generato se il codice del paese
specificato non è valido
Questo errore viene generato se non è presente alcun
contratto attivo per il CSN del rivenditore specificato.
Questo errore viene generato se non viene specificato alcun
CSN di rivenditore o codice di paese.
Questo errore viene generato se nell'intestazione della
richiesta non vengono impostate la data e l'ora
richiesta non viene impostata alcuna firma
richiesta non viene impostato alcun CSN
richiesta non viene impostata alcuna autorizzazione
Questo errore viene generato se il valore dell'autorizzazione
nell'intestazione non è corretto o valido.
Questo errore viene generato se il valore del CSN
Questo errore viene generato se il valore della data e dell'ora
Questo errore viene generato se il valore della firma
4.6.1
Esempio di risposta di errore
{
"PartnerDesignationList": null,
"error_message": "Please provide ResellerCSN or CountryCode."
"error_code": "UAN-SPZ-00004"
}
Nota: questo manuale di riferimento del servizio è destinato all'utilizzo esclusivo dei legittimi
destinatari e può contenere informazioni proprietarie e/o riservate di natura privilegiata o
comunque protette dalla divulgazione. La revisione, l'uso, la divulgazione o la distribuzione non
autorizzati sono vietati.

Get Partner Designation Service Reference Manual

Transcript

Documenti analoghi

certificato di frequenza di un corso di lingua 5513w a 55133210

180 diodi per una luce naturale

Acquistare auto usate: qualche consiglio

MODULO 1 Ricercare nella rete

Scaricare il testo di garanzia dei televisori

Totale (€) Euro - Valassis Rivenditori

CARTELLO SIGARETTE AI MINORI 18 anni

Lezione di informatica – Simulazione d`esame/ 15/12/2015/ Foglio

Scarica file - GeoPaleoDiet

ASSISTANT-i-XT - Csn Industrie