Serviç os da Web de distribuiç ã o digital (DDWS) GetMyPrice - Serviço manual

Transcrição

1 Serviç os da Web de distribuiç ã o digital (DDWS) GetMyPrice - Serviço manual

2 ÍNDICE Histórico de revisão Introdução Visão geral Documentos de suporte Introdução Visão geral do serviço GetMyPrice Detalhes do GetMyPrice Vantagens do serviço GetMyPrice Informações de referência do serviço GetMyPrice Esquema de solicitação Esquema de resposta Esquema de erro Mensagens de solicitação Mensagens de resposta Mensagens de erro Códigos e mensagens de erro Amostra de respostas de erro... 9 Histórico de revisão Versão Data Autor Comentários /10/2015 AR Seção Histórico de revisão adicionada /11/2015 AR Foi corrigida a utilização para exibir Opcional "em vez de" Mpcional para o campo Quantidade na seção /12/2015 AR Foram atualizadas as mensagens de resposta na seção /03/16 PL Foram atualizados os códigos de erro e as mensagens na seção Manual de referê ncia do serviç o da Web

3 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 2 Introdução 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. 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 parceiros da Autodesk. 3 Manual de referê ncia do serviç o da Web

4 3 Visão geral do serviço GetMyPrice 3.1 Detalhes do GetMyPrice. O objetivo do serviço GetMyPrice é permitir o seguinte: 1. Fornecer ao Disti/DVAR o preço de compra 2. Fornecer aos parceiros não diretos o preço de revenda sugerido 3. Durante a criação do pedido (via PlaceOrder), forneça o preço que o parceiro está pagando neste pedido específico. a) Por exemplo, se você estiver adicionando a um contrato existente, o preço no pedido poderá precisar ser parcelado. 3.2 Vantagens do serviço GetMyPrice 1. Um serviço da Web REST leve que pode ser consumido facilmente em qualquer aplicativo por meio da conexão HTTP(s). 2. Fornece a correção de preços por Parceiro e SKU. 3. Ajuda na entrada e na validação de pedidos 4. Melhora a qualidade dos dados recuperando informações sobre preços em tempo real. 4 Manual de referê ncia do serviç o da Web

5 4 Informações de referência do serviço GetMyPrice 4.1 Esquema de solicitação O Esquema de solicitação para GetMyPrice tem os seguintes Campos como entradas. Os campos part_number, customer_number e price_date devem ser incluídos em uma solicitação do Parceiro, juntamente com uma das seguintes combinações de campos restantes: 1) Nenhum deles. 2) agreement_number 3) opportunity_number 4) quantity 5) agreement_number, quantity 6) opportunity_number, quantity Nome do campo Tipo de campo Comprimento/formato de entrada Utilização part_number STRING Comprimento máximo 17 Obrigatório customer_number INT length == 10 Obrigatório opportunity_number STRING N/D Opcional agreement_number INT length == 12 Opcional price_date DATE Formato: ISO 8601 AAAA-MM-DD Obrigatório quantity INT Comprimento máximo 13 Opcional 4.2 Esquema de resposta Nome do campo status_code status message response Descrição Código correspondente ao tipo de status Resposta de confirmação: "OK", "FALHA", "ERRO" Compartilha o tipo de preço Preço total 5 Manual de referê ncia do serviç o da Web

6 4.3 Esquema de erro Nome do campo Descrição status Resposta de confirmação: "OK", "FALHA", "ERRO" status code Código correspondente ao status exibido message Mensagem de falha ou erros message_code Código correspondente à determinada mensagem de erro exibida error_message Diz o motivo do erro ser lançado response. Vazio devido a erro sendo lançado. 4.4 Mensagens de solicitação Abaixo estão as solicitações de amostra correspondentes a diferentes combinações de parâmetros. 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 Manual de referê ncia do serviç o da Web

7 4.5 Mensagens de resposta Estas são as Mensagens de resposta correspondentes às solicitações de amostra anteriores. 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 Manual de referê ncia do serviç o da Web

8 4.6 Mensagens de erro A seguinte tabela mostra os exemplos de códigos de erro e as respectivas mensagens de erro presentes nas mensagens de resposta caso um erro seja encontrado: Códigos e mensagens de erro Estes são os códigos e as mensagens de erro correspondentes a este serviço. Número da mensagem UAN-GEN UAN-GEN UAN-GEN UAN-GEN UAN-GEN UAN-GEN APG-DWS-INV-002 Mensagem de erro Número do cliente é obrigatório. Número inválido de cliente. Verifique sua entrada e tente novamente Forneça uma combinação válida de parâmetros Forneça os nomes de parâmetros à direita Insira o número SKU O Número do pedido deve ter exatos 10 caracteres. Verifique sua entrada e tente novamente O Número do cliente fornecido é inválido. Insira um opportunity_number válido. 8 Manual de referê ncia do serviç o da Web

9 4.6.2 Amostra de respostas de erro 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: 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. 9 Manual de referê ncia do serviç o da Web