Serviços da rede de distribuição digital (DDWS) GetPartnerDesignation - Manual do serviço

Transcrição

1 Serviços da re distribuição digital (DDWS) GetPartnerDesignation - Manual do serviço

2 ÍNDICE Histórico revisão Introdução Visão geral Documentos suporte Introdução Visão geral do serviço Partner Designation Benefícios do serviço GetPartnerDesignation Informações referência do serviço GetPartnerDesignation Esquema solicitação Esquema resposta Esquema erro Mensagens solicitação Mensagem resposta Mensagem resposta GetPartnerDesignation usando o CSN do revendor como entrada Mensagem resposta GetPartnerDesignation usando o código do país como entrada Mensagens erro Amostra resposta erro Histórico revisão Versão Data Autor Comentários /09/2016 SJ Versão inicial 2 Manual referência do serviço da Web

3 1 Introdução 1.1 Visão geral A plataforma do Serviço da Web distribuição digital (DDWS) é uma solução para realização pedidos criada diretamente por nossos Parceiros para a Autosk, com pouco toque dos Parceiros e nenhum toque da Autosk.Este novo recurso negócios permitirá as transações serviço Web B2B verdairas entre os Parceiros e a Autosk. Para os Parceiros têm a implementação efetiva da Plataforma serviços digitais da Autosk, as afiliadas precisarão ter familiarida com os serviços da Web REST, o OAuth e o JSON. Uma amostra um aplicativo cliente é fornecida (gravado na linguagem Ruby) em um documento Guia programação, que ajudarão os chamados senvolvedores afiliados a consumirem a API do serviço digital. 1.2 Documentos suporte Guia do senvolvedor para parceiros da Autosk: este guia ajuda os Parceiros no processo apresentação e no acesso aos serviços do DDWS. O guia também serve para apresentar aos Parceiros a Plataforma serviços digitais da Autosk, usando instruções passo a passo que os orientam nas atividas iniciais necessárias para integração. Documentação da API autenticação: este documento orientará os Parceiros pelo processo geração crenciais, assinaturas e tokens acesso necessários para usar as APIs do serviço. Ele também contém informações para o senvolvimento um aplicativo integração um Parceiro. Ele fornece a compreensão básica da integração do serviço da Web e monstra o senvolvimento um aplicativo típico. 2 Introdução Como parte do processo 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 Autosk. Para obter mais talhes sobre o processo integração, consulte o Guia do senvolvedor para parceiros da Autosk. 3 Manual referência do serviço da Web

4 3 Visão geral do serviço Partner Designation Este serviço faz e fornece o seguinte: Obtém as informações conhecimento, da conta e da conta 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 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 Parceiro (VAR Spez Report Dist) 2. Um serviço da Web REST leve, que po ser consumido facilmente qualquer aplicativo. 3. Os parceiros têm flexibilida para obter informações especialistas com um terminado número CSN do revendor ou fornecendo um código do país. 4 Manual referência do serviço da Web

5 4 Informações referência do serviço GetPartnerDesignation 4.1 Esquema solicitação Os talhes dos Parâmetros mensagem solicitação na tabela a seguir para GetPartnerDesignation. Elemento CSN CountryCo ResellerCSN Tipo campo Comprimento/format o entrada Utilização 10 Obrigatório Código do país ISO com 2 dígitos Obrigatório caso o ResellerCSN não seja fornecido 10 Obrigatório caso o CountryCo não seja fornecido 4.2 Esquema resposta Para o envio do intervalo datas, as colunas a seguir serão exibidas. Campo PartnerDesignationList AccountCSN ParentAccountCSN AccountName Address1 Address2 Address3 Cida Tipo campo Matriz do objeto JSON Comprimento/formato saída Descrição 30 Intificador único para a conta do cliente final/ empresa/ parceiro 30 CSN da conta principal na hierarquia (ex.: doméstico finitivo) 255 Nome da empresa associado à conta 255 Enreço físico da empresa associada à conta 100 Enreço físico da empresa associada à conta 100 Enreço físico da empresa associada à conta 50 Cida do revendor 5 Manual referência do serviço da Web

6 ZipCo Estado País SalesRegion ContractEndDate ContractType PartnerHierachy PartnerTier ExpertiseList ExpertiseType Especialida error_co error_message Formato data ISO 8601 Matriz objetos JSON Matriz objetos JSON 30 CEP do revendor 50 Estado do revendor 50 País do revendor 40 Região vendas no contrato parceiro 10 Data término contrato do parceiro 255 Tipo contrato com base no tipo parceiro 255 Conta na hierarquia 255 Nível do parceiro no contrato parceiro 255 Tipo especialização ao qual o parceiro está associado 80 Especialização ao qual o parceiro está associado 13 Código erro 250 Mensagem erro 6 Manual referência do serviço da Web

7 4.3 Esquema erro Nome do campo PartnerDesignationList Mensagem erro Código erro Descrição nulo Um breve resumo que indica o erro. Um código com o formato 000XX. 4.4 Mensagens solicitação A seguir estão amostras solicitações para GetPartnerDesignation. [Getting GetPartnerDesignation using Reseller CSN] Message Hears 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 Co] Message Hears Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>> 7 Manual referência do serviço da Web

8 4.5 Mensagem resposta Nota: a Autosk enviará uma resposta com a estrutura a seguir. Os Parceiros pom reformatar para diferentes estruturas acordo com suas necessidas Mensagem resposta GetPartnerDesignation usando o CSN do revendor como entrada "PartnerDesignationList": [ "ZipCo": "560086", "State": "KARNATAKA", "SalesRegion": "INDIA", "PartnerTier": "Gold", "PartnerHierachy": "Domestic Ultimate", "ParentAccountCSN": " ", "ExpertiseList": [ "Expertise": "AutoCAD" "Expertise": "M&E" "ExpertiseType": "Product Group", "Expertise": "Base" "Expertise": "Building" "Expertise": "Civil Infrastructure" "Expertise": "Product Design & Manufacturing" "ExpertiseType": "Product Group", "Expertise": "Open" "Expertise": "Advanced Structure" 8 Manual referência do serviço da Web

9 ], "Country": "India", "ContractType": "IVAR", "ContractEndDate": " ", "City": "Bengaluru", "Address3": null, "Address2": "EBIPBCHKGB", "Address1": "AFAEAFHGDM", "AccountName": "NHFGGLIOAMKJNNEIELFIGCIBDPOLIEON", "AccountCSN": " " ], "error_message": "", "error_co": "" Mensagem resposta GetPartnerDesignation usando o código do país como entrada "PartnerDesignationList": [ "ZipCo": "81000", "State": null, "SalesRegion": "Central Europe", "PartnerTier": "Silver", "PartnerHierachy": "Domestic Ultimate", "ParentAccountCSN": " ", "ExpertiseList": [ "ExpertiseType": "Product Group", "Expertise": "Base" "Expertise": "Civil Infrastructure" "ExpertiseType": "Product Group", "Expertise": "Open" "Expertise": "AutoCAD" ], "Country": "Montenegro", "ContractType": "IVAR", "ContractEndDate": " ", "City": "Podgorica", 9 Manual referência do serviço da Web

10 "Address3": null, "Address2": "HKIJFOMGJE", "Address1": "JHOIDNIPME", "AccountName": "KGGLHLGJLOEEDDJCDGMHMGGLPIOMEBGN", "AccountCSN": " " "ZipCo": "81000", "State": null, "SalesRegion": "Central Europe", "PartnerTier": "Bronze", "PartnerHierachy": "Domestic Ultimate", "ParentAccountCSN": " ", "ExpertiseList": [ "Expertise": "AutoCAD" ], "Country": "Montenegro", "ContractType": "IVAR", "ContractEndDate": " ", "City": "Podgorica", "Address3": null, "Address2": null, "Address1": "NECDGMEGDE", "AccountName": "OBJAMNAMMKBAJHJKDHJPGCMMDAKAGPKJ", "AccountCSN": " " "ZipCo": "81000", "State": null, "SalesRegion": "Central Europe", "PartnerTier": "Bronze", "PartnerHierachy": "Domestic Ultimate", "ParentAccountCSN": " ", "ExpertiseList": [ "ExpertiseType": "Product Group", "Expertise": "Base" "ExpertiseType": "Product Group", "Expertise": "Open" "Expertise": "AutoCAD" ], "Country": "Montenegro", "ContractType": "IVAR", "ContractEndDate": " ", 10 Manual referência do serviço da Web

11 "City": "Podgorica", "Address3": null, "Address2": null, "Address1": "HCLKLBBPIB", "AccountName": "MGFHEAHPMLHLPBHHONCODBPDEEILAOAF", "AccountCSN": " " ], "error_message": "", "error_co": "" 4.6 Mensagens erro A tabela a seguir mostra os códigos erro e as respectivas mensagens erro presentes na resposta mensagens caso um erro seja encontrado: Número da mensagem Mensagem erro CSN não autorizado O CSN do revendor fornecido não é válido ou não tem um tipo parceiro válido. O código do país não é válido. Nenhum contrato ativo foi encontrado para o CSN. Forneça o ResellerCSN ou o CountryCo. Carimbo data/hora ausente no cabeçalho. Assinatura ausente no cabeçalho. CSN ausente no cabeçalho. Autorização ausente no cabeçalho. Token inválido no cabeçalho. CSN inválido no cabeçalho. Indicação data/hora inválida no cabeçalho. Descrição do erro Esse erro será gerado se o CSN da parte Vendido para enviado pelo parceiro não for do tipo parceiro Revendor principal ou Distribuidor. Esse erro será gerado se o CSN do revendor fornecido não tiver um tipo parceiro igual a Revendor, Revendor principal, VCP ou ISV. Esse erro será gerado se o código do país fornecido não for válido. Esse erro será gerado se não houver nenhum contrato ativo encontrado para o CSN do revendor fornecido. Esse erro será gerado se nenhuma das entradas ResellerCSN ou CountryCo for fornecida. Esse erro será gerado se o carimbo data/hora do cabeçalho não estiver finido na solicitação Esse erro será gerado se a assinatura do cabeçalho não estiver finida na solicitação Esse erro será gerado se o CSN do cabeçalho não estiver finido na solicitação Esse erro será gerado se a autorização do cabeçalho não estiver finida na solicitação Esse erro será gerado se o valor da autorização do cabeçalho estiver incorreto ou não for válido. Esse erro será gerado se o valor do CSN do cabeçalho estiver incorreto ou não for válido. Esse erro será gerado se o valor do carimbo data/hora do cabeçalho estiver incorreto ou não for válido. 11 Manual referência do serviço da Web

12 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 Amostra resposta erro "PartnerDesignationList": null, "error_message": "Please provi ResellerCSN or CountryCo." "error_co": "00004" Nota: este Manual referência do serviço é para uso exclusivo pelos stinatários pretendidos e po conter informações proprietárias e/ou confinciais que pom ser privilegiadas ou protegidas contra divulgação. Qualquer revisão, utilização, divulgação ou distribuição não autorizada é proibida. 12 Manual referência do serviço da Web