Serviços da rede de distribuição digital (DDWS)
GetPartnerDesignation - Manual do
ÍNDICE
Histórico de revisão ... 2 1 Introdução ... 3 1.1 Visão geral ... 3 1.2 Documentos de suporte ... 3 2 Introdução ... 33 Visão geral do serviço Partner Designation ... 4
3.1 Benefícios do serviço GetPartnerDesignation ... 4
4 Informações de referência do serviço GetPartnerDesignation ... 5
4.1 Esquema de solicitação ... 5
4.2 Esquema de resposta ... 5
4.3 Esquema de erro ... 7
4.4 Mensagens de solicitação ... 7
4.5 Mensagem de resposta ... 8
4.5.1 Mensagem de resposta – GetPartnerDesignation usando o CSN do revendedor como entrada .... 8
4.5.2 Mensagem de resposta – GetPartnerDesignation usando o código do país como entrada ... 9
4.6 Mensagens de erro ... 11
4.6.1 Amostra de resposta de erro ... 12
Histórico de revisão
Versão Data Autor Comentários
1 Introdução
1.1 Visão geral
A plataforma do Serviço da Web de distribuição digital (DDWS) é uma solução para realização de pedidos criada diretamente por nossos Parceiros para a Autodesk, com pouco toque dos Parceiros e nenhum toque da Autodesk.Este novo recurso de negócios permitirá as transações de serviço Web B2B verdadeiras entre os Parceiros e a Autodesk.
Para os Parceiros têm a implementação efetiva da Plataforma de serviços digitais da Autodesk, as afiliadas precisarão ter familiaridade com os serviços da Web REST, o OAuth e o JSON. Uma amostra de um aplicativo de cliente é fornecida (gravado na linguagem Ruby) em um documento Guia de
programação, que ajudarão os chamados desenvolvedores afiliados a consumirem a API do serviço digital.
1.2 Documentos de suporte
• Guia do desenvolvedor para parceiros da Autodesk: este guia ajuda os Parceiros no processo de apresentação e no acesso aos serviços do DDWS. O guia também serve para apresentar aos Parceiros a Plataforma de serviços digitais da Autodesk, usando instruções passo a passo que os orientam nas atividades iniciais necessárias para integração.
• Documentação da API de autenticação: este documento orientará os Parceiros pelo processo de geração de credenciais, assinaturas e tokens de acesso necessários para usar as APIs do serviço. Ele também contém informações para o desenvolvimento de um aplicativo de integração de um Parceiro. Ele fornece a compreensão básica da integração do serviço da Web e demonstra o desenvolvimento de um aplicativo típico.
2 Introdução
Como parte do processo de apresentação, os Parceiros serão associados a um único Número específico do cliente (CSN) e terão seu aplicativo registrado com a Autodesk.
Para obter mais detalhes sobre o processo de integração, consulte o Guia do desenvolvedor para
3 Visão geral do serviço Partner Designation
Este serviço faz e fornece o seguinte:
• Obtém as informações de conhecimento, da conta e da conta de contrato com base no ResellerCSN ou país especificado.
• Valida o CSN e o ResellerCSN fornecidos. Se a solicitação for inválida, a resposta retornará um erro.
3.1 Benefícios do serviço GetPartnerDesignation
1. É um relatório de autoatendimento com base em dados em tempo real
a. Conforme um contrato é alterado, ele é imediatamente refletido neste relatório
b. Foram substituídos os relatórios semanais publicados no momento no Centro de Parceiro (VAR Spez Report Dist)
2. Um serviço da Web REST leve, que pode ser consumido facilmente de qualquer aplicativo.
3. Os parceiros têm flexibilidade para obter informações de especialistas com um determinado número CSN do revendedor ou fornecendo um código do país.
4 Informações de referência do serviço GetPartnerDesignation
4.1 Esquema de solicitação
Os detalhes dos Parâmetros de mensagem de solicitação na tabela a seguir para GetPartnerDesignation.
Elemento Tipo de campo Comprimento/format
o de entrada Utilização CSN Sequência de caracteres 10 Obrigatório CountryCode Sequência de caracteres
Código do país ISO com 2 dígitos Obrigatório caso o ResellerCSN não seja fornecido ResellerCSN Sequência de caracteres 10 Obrigatório caso o CountryCode não seja fornecido
4.2 Esquema de resposta
Para o envio do intervalo de datas, as colunas a seguir serão exibidas.
Campo Tipo de campo Comprimento/formato de saída Descrição PartnerDesignationList Matriz do objeto JSON AccountCSN Sequência de caracteres
30
Identificador único para aconta do cliente final/de empresa/de parceiro ParentAccountCSN Sequência
de
caracteres
30
CSN da conta principal nahierarquia (ex.: doméstico definitivo) AccountName Sequência de caracteres
255
Nome da empresa associado à conta Address1 Sequência de caracteres255
Endereço físico da empresaassociada à conta
Address2 Sequência
de
caracteres
100
Endereço físico da empresaassociada à conta
Address3 Sequência
de
caracteres
100
Endereço físico da empresaassociada à conta
Cidade Sequência
de
caracteres
ZipCode Sequência de caracteres
30
CEP do revendedor Estado Sequência de caracteres50
Estado do revendedor País Sequência de caracteres50
País do revendedor SalesRegion Sequência de caracteres40
Região de vendas no contrato de parceiro ContractEndDate Formato de data ISO 860110
Data de término de contratodo parceiro
ContractType Sequência
de
caracteres
255
Tipo de contrato com baseno tipo de parceiro PartnerHierachy Sequência de caracteres
255
Conta na hierarquia PartnerTier Sequência de caracteres255
Nível do parceiro no contrato de parceiro ExpertiseList Matriz de objetos JSON ExpertiseType Sequência de caracteres255
Tipo de especialização aoqual o parceiro está associado
Especialidade Sequência
de
caracteres
80 Especialização ao qual o
parceiro está associado Matriz de objetos JSON error_code Sequência de caracteres 13 Código de erro error_message Sequência de caracteres 250 Mensagem de erro
4.3 Esquema de erro
Nome do campo Descrição
PartnerDesignationList “nulo”
Mensagem de erro Um breve resumo que indica o erro.
Código de erro Um código com o formato UAN-SPZ-000XX.
4.4 Mensagens de solicitação
A seguir estão amostras de solicitações para 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>>
4.5 Mensagem de resposta
Nota: a Autodesk enviará uma resposta com a estrutura a seguir. Os Parceiros podem reformatar para diferentes estruturas de acordo com suas necessidades.
4.5.1 Mensagem de resposta – GetPartnerDesignation usando o CSN do revendedor
como entrada
{ "PartnerDesignationList": [ { "ZipCode": "560086", "State": "KARNATAKA", "SalesRegion": "INDIA", "PartnerTier": "Gold","PartnerHierachy": "Domestic Ultimate", "ParentAccountCSN": "5070293421", "ExpertiseList": [ { "ExpertiseType": "Specialization", "Expertise": "AutoCAD" }, { "ExpertiseType": "Specialization", "Expertise": "M&E" }, {
"ExpertiseType": "Product Group", "Expertise": "Base" }, { "ExpertiseType": "Specialization", "Expertise": "Building" }, { "ExpertiseType": "Specialization", "Expertise": "Civil Infrastructure" },
{
"ExpertiseType": "Specialization",
"Expertise": "Product Design & Manufacturing" },
{
"ExpertiseType": "Product Group", "Expertise": "Open"
}, {
"ExpertiseType": "Specialization", "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 Mensagem de resposta – GetPartnerDesignation usando o código do país como
entrada
{ "PartnerDesignationList": [ { "ZipCode": "81000", "State": null,"SalesRegion": "Central Europe", "PartnerTier": "Silver",
"PartnerHierachy": "Domestic Ultimate", "ParentAccountCSN": "5101529925", "ExpertiseList": [
{
"ExpertiseType": "Product Group", "Expertise": "Base"
}, {
"ExpertiseType": "Specialization", "Expertise": "Civil Infrastructure" },
{
"ExpertiseType": "Product Group", "Expertise": "Open" }, { "ExpertiseType": "Specialization", "Expertise": "AutoCAD" } ], "Country": "Montenegro", "ContractType": "IVAR",
"Address3": null, "Address2": "HKIJFOMGJE", "Address1": "JHOIDNIPME", "AccountName": "KGGLHLGJLOEEDDJCDGMHMGGLPIOMEBGN", "AccountCSN": "5101529925" }, { "ZipCode": "81000", "State": null,
"SalesRegion": "Central Europe", "PartnerTier": "Bronze",
"PartnerHierachy": "Domestic Ultimate", "ParentAccountCSN": "5104195857", "ExpertiseList": [ { "ExpertiseType": "Specialization", "Expertise": "AutoCAD" } ], "Country": "Montenegro", "ContractType": "IVAR", "ContractEndDate": "2016-01-31", "City": "Podgorica", "Address3": null, "Address2": null, "Address1": "NECDGMEGDE", "AccountName": "OBJAMNAMMKBAJHJKDHJPGCMMDAKAGPKJ", "AccountCSN": "5104195857" }, { "ZipCode": "81000", "State": null,
"SalesRegion": "Central Europe", "PartnerTier": "Bronze",
"PartnerHierachy": "Domestic Ultimate", "ParentAccountCSN": "5106831422", "ExpertiseList": [
{
"ExpertiseType": "Product Group", "Expertise": "Base"
}, {
"ExpertiseType": "Product Group", "Expertise": "Open" }, { "ExpertiseType": "Specialization", "Expertise": "AutoCAD" } ], "Country": "Montenegro", "ContractType": "IVAR", "ContractEndDate": "2016-01-31",
"City": "Podgorica", "Address3": null, "Address2": null, "Address1": "HCLKLBBPIB", "AccountName": "MGFHEAHPMLHLPBHHONCODBPDEEILAOAF", "AccountCSN": "5106831422" } ], "error_message": "", "error_code": "" }
4.6 Mensagens de erro
A tabela a seguir mostra os códigos de erro e as respectivas mensagens de erro presentes na resposta mensagens caso um erro seja encontrado:
Número da mensagem
Mensagem de erro Descrição do erro
UAN-SPZ-00005
CSN não autorizado Esse erro será gerado se o CSN da parte Vendido para enviado pelo parceiro não for do tipo de parceiro “Revendedor principal” ou “Distribuidor”.
UAN-SPZ-00001
O CSN do
revendedor fornecido não é válido ou não tem um tipo de parceiro válido.
Esse erro será gerado se o CSN do revendedor fornecido não tiver um tipo de parceiro igual a Revendedor, Revendedor principal, VCP ou ISV.
UAN-SPZ-00002
O código do país não é válido.
Esse erro será gerado se o código do país fornecido não for válido.
UAN-SPZ-00003
Nenhum contrato ativo foi encontrado para o CSN.
Esse erro será gerado se não houver nenhum contrato ativo encontrado para o CSN do revendedor fornecido.
UAN-SPZ-00004
Forneça o
ResellerCSN ou o CountryCode.
Esse erro será gerado se nenhuma das entradas ResellerCSN ou CountryCode for fornecida.
UAN-SPZ-04103
Carimbo de data/hora ausente no
cabeçalho.
Esse erro será gerado se o carimbo de data/hora do cabeçalho não estiver definido na solicitação
UAN-SPZ-04102
Assinatura ausente no cabeçalho.
Esse erro será gerado se a assinatura do cabeçalho não estiver definida na solicitação
UAN-SPZ-04100
CSN ausente no cabeçalho.
Esse erro será gerado se o CSN do cabeçalho não estiver definido na solicitação
UAN-SPZ-04104
Autorização ausente no cabeçalho.
Esse erro será gerado se a autorização do cabeçalho não estiver definida na solicitação
UAN-SPZ-04303
Token inválido no cabeçalho.
Esse erro será gerado se o valor da autorização do cabeçalho estiver incorreto ou não for válido.
UAN-SPZ-04300
CSN inválido no cabeçalho.
Esse erro será gerado se o valor do CSN do cabeçalho estiver incorreto ou não for válido.
UAN-SPZ-04302
Indicação de
data/hora inválida no
Esse erro será gerado se o valor do carimbo de data/hora do cabeçalho estiver incorreto ou não for válido.
UAN-SPZ-04301
Assinatura inválida no cabeçalho.
Esse erro será gerado se o valor da assinatura do cabeçalho estiver incorreto ou não for válido.
4.6.1 Amostra de resposta de erro
Nota: este Manual de referência do serviço é para uso exclusivo pelos destinatários pretendidos e pode conter informações proprietárias e/ou confidenciais que podem ser privilegiadas ou protegidas contra divulgação. Qualquer revisão, utilização, divulgação ou distribuição não autorizada é proibida.
{
"PartnerDesignationList": null,
"error_message": "Please provide ResellerCSN or CountryCode." "error_code": "UAN-SPZ-00004"
