Serviços da rede de distribuição digital (DDWS) PlaceOrder - Serviço manual

Transcrição

1 Serviços da rede de distribuição digital (DDWS) PlaceOrder - Serviço manual

2 ÍNDICE Histórico de revisão Introdução Visão geral Documentação de suporte Introdução Visão geral do serviço PlaceOrder Assinatura da Autodesk Renovável Atendimento do pedido Revogação de pedido Mensagens SNS Obtenção de status do pedido Informações de referência do serviço PlaceOrder Atendimento do pedido Esquema de solicitação - Criar pedido inicial Esquema de solicitação Adicionar licenças Esquema de solicitação Adicionar produtos Esquema de solicitação Renovar Atualizar ordem de compra recorrente Esquema de solicitação Atualizar ordem de compra recorrente Obtenção de status do pedido Esquema de solicitação Obtenção de status do pedido [apenas para um pedido inicial recorrente] Revogação de pedido Esquema de solicitação Remover licenças, remover produtos, cancelamento de pedido Esquema de resposta - Criar pedido inicial Esquema de resposta Atualizar ordem de compra recorrente Esquema de responsta Obtenção de status do pedido Esquema de resposta - Remover licença, Remover produto, Cancelamento de pedido [somente ] Esquema de resposta Notificação de SNS Amostra de mensagens Mensagem de solicitação Atendimento de pedidos, Pedido inicial, Modelo de assinatura recorrente Mensagem de resposta Atendimento de pedidos, Pedido inicial Manual de referência do serviço da Web

3 5.2 Mensagem de solicitação Atendimento de pedidos, Pedido inicial, Modelo de assinatura renovável Mensagem de resposta Atendimento de pedidos, Pedido inicial Mensagem de solicitação Atendimento de pedidos, Adicionar licenças, Modelo de assinatura recorrente Mensagem de resposta Atendimento de pedidos, Adicionar licenças, Modelo de assinatura recorrente Mensagem de solicitação Atendimento de pedidos, Adicionar licenças, Modelo de assinatura renovável Mensagem de resposta Atendimento de pedidos, Adicionar licenças, Modelo de assinatura renovável Mensagem de solicitação Atendimento de pedidos, Adicionar produtos, Modelo de assinatura recorrente Mensagem de resposta Atendimento de pedidos, Adicionar produtos, Modelo de assinatura recorrente Mensagem de solicitação Atendimento de pedidos, Adicionar produtos, Modelo de assinatura renovável Mensagem de resposta Atendimento de pedidos, Adicionar produtos, Modelo de assinatura renovável Mensagem de solicitação Atendimento de pedidos, Renovação, Modelo de assinatura renovável somente Mensagem de resposta Atendimento de pedidos, Renovação, Modelo de assinatura renovável somente Mensagem de solicitação Atualizar ordem de compra recorrente Mensagem de resposta Atualizar ordem de compra recorrente Mensagem de solicitação Obtenção de status do pedido Mensagem de resposta Obtenção de status do pedido Mensagem de solicitação Revogação de pedidos (Remover posição, Remover produto, Cancelamento de pedido) Mensagem de resposta - Revogação de pedido (Remover licença, Remover produto, Cancelamento de pedido) Mensagem de solicitação - Revogação de pedido (devoluções de pedido) Mensagem de resposta - Revogação de pedido (devoluções de pedido) Mensagem de solicitação Mensagens SNS Mensagem de resposta Mensagens SNS Normas de formatação Mensagens de erro Códigos de erro Mensagem de erro Manual de referência do serviço da Web

4 Histórico de revisão Versão Data Autor Comentários /10/2015 AR Seções adicionadas 4.2, 4.7, 5.2 e para incluir o serviço de Cobrança recorrente /10/2015 AR O serviço anteriormente chamado de Cobrança recorrente foi atualizado para Atualizar ordem de compra recorrente e Solicitar URL /10/2015 AR Os valores action_name do Atendimento de pedidos foram modificados de add_seat e add_product para add_seats e add_products /11/2015 AR A Mensagem de solicitação de amostra do Atendimento de pedidos e do Pedido inicial na seção 5.1 foi modificada para exibir uma carga útil de amostra para modelos de modelos recorrentes do Subscription. A Mensagem de solicitação de amostra do Atendimento de pedidos e do Pedido inicial na seção 5.2 foi modificada para exibir uma carga útil de amostra para modelos de modelos renováveis do Subscription. Foi modificada a criação de um esquema de 4 Manual de referência do serviço da Web

5 solicitação de pedido inicial na seção /11/2015 AR Foi adicionado um Esquema de solicitação add_seats na seção 4.3 Foi adicionado um Esquema de solicitação add_products na seção 4.4 Foi adicionado um Esquema de solicitação renew na seção 4.5 Foi modificado um Esquema de solicitação initial_order na seção 4.2 Foram adicionadas as seções 5.3, 5.4, 5.5, 5.6 e 5.7 para incluir Mensagens de amostra para ações de atendimento de pedidos: add_seats, add_products e renew /11/2015 AR Foram atualizados os dados de amostra das Mensagens de amostra na Seção 5. Foi atualizado o Esquema de solicitação "Renew" na Seção 4.5 para mover "subscription_id". Foi atualizado o Esquema de solicitação "initial_order" na 5 Manual de referência do serviço da Web

6 seção 4.2 para remover "external_ref_ number" /11/2015 AR Os exemplos de data de esquema de solicitação foram modificados para se ajustarem ao formato ISO 8601 Os valores possíveis de action_name para revogação de pedido foram atualizados para remover produtos, remover licenças, cancelar e voltar. Nota: voltar não está disponível no momento. O esquema de solicitação de revogação de pedido foi atualizado na seção 4.11 Foram adicionadas descrições para os modelos de Desktop Subscription na seção 3.1 Foi adicionado related_account_cs n para o esquema de solicitação para adicionar licenças na seção 4.3 Foi removido pricing_date do esquema de solicitação para adicionar licenças na seção 4.3 Foram modificados os códigos de erro na seção Manual de referência do serviço da Web

7 3.5 21/12/2015 AR Foram modificadas as seções 4.2 a 4.5 para refletir o último esquema de solicitação Foi modificada a seção 4.9 de po_number para reference number /02/2016 RL Converter todos os campos denominados quantidade para número inteiro /02/2016 RL Substituir o campo ref_document pelos campos opportunity type e opportunity_number /02/2016 RL Remover o campo order_date. Indicar as regras em contract_start_date /02/2016 CC Atualizar documentação para esquema de resposta da API de status /02/2016 CC Atualizar SNS para indicar a disponibilidade de todos os serviços para fazer pedido /03/16 PL Na seção 4.2, foram removidos os comentários de first_name, last_name, , eu_first_name, eu_last_name, eu_ Na seção 4.2, foi alterado de O para R em first_name, last_name, , 7 Manual de referência do serviço da Web

8 eu_first_name, eu_last_name, eu_ Na seção 4.2, foi editada a seção de comentário para somente fornecer se conhecido para contact_csn, eu_contact_csn Na seção 4.2, na seção de comentários de todos os campos que começam com primary_account, related_account, eu_primary_account, foi adicionado "*As regras se aplicam a somente recorrente /03/16 PL Nas seções 4.2, 4.3, 4.4, 4.11, foram atualizados todos os campos Quantidade para número inteiro positivo Nas seções 4.2,4.3, 4.4, foram atualizados os campos e eu_ para o máximo de 80 Nas seções 4.2, 4.4, 5.1, foram adicionados Address_Line2 e Address_Line3 para os campos Primary, Eu_Primary e Related Account /05/16 PL Foram removidos os seguintes campos das seções 4.2, 4.3, 4.4, 4.5 e suas 8 Manual de referência do serviço da Web

9 mensagens de resposta correspondentes: item_end_date, contact_csn, eu_csn, contract_end_date, currency_code, eu_contact_csn Foram adicionadas descrições a todos os campos nas seções 4.2, 4.3, 4.4, 4.5. Foi adicionada uma possível mensagem de erro a de julho de 2016 FX Removidas todas as ocorrências do Desktop Subscription, já que esta terminologia está obsoleta. A duração da assinatura era denominada período. Na versão em inglês, multiyear foi alterado para multiyear (multianual) já que agora é um período genérico. 9 Manual de referência do serviço da Web

10 1 Introdução 1.1 Visão geral Os Serviços da Web de distribuição digital (DDWS) consistem em uma solução para realização de pedidos diretamente pelos Parceiros para a Autodesk, com pouco toque dos Parceiros e nenhum toque da Autodesk. O novo recurso de negócios é a capacidade de realizar transações verdadeiras do serviço da Web B2B entre os nossos Parceiros e a Autodesk. O envio do pedido deve ser totalmente automatizado do Parceiro para a Autodesk e de volta para o cliente final sem contato manual. Para que o Parceiro tenha uma implementação efetiva do DDWS da Autodesk, as afiliadas precisarão ter a familiaridade dos serviços da Web REST, do OAuth 2.0 e do JSON. Uma amostra de um aplicativo de cliente na linguagem Ruby é fornecida no documento Guia de programação. Isso ajuda os desenvolvedores das afiliadas a consumir a API do DDWS. 1.2 Documentação de suporte 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. Detalhes da interface/esquema da API: este documento contém informações de carga em relação a todos os possíveis cenários para Fazer Pedido, ele pode ser usado por desenvolvedores para gerar as solicitações de amostra preenchendo os campos desejados. Para obter mais informações sobre o Autodesk Web Services, consulte o Portal do desenvolvedor, onde você pode encontrar toda a documentação disponível e instruções passo a passo sobre como nossos serviços funcionam. 2 Introdução Como parte do processo de integração, os Parceiros serão associados a um único Número específico do cliente (CSN). O Parceiro terá seu respectivo aplicativo registrado com a Autodesk. Para obter mais detalhes sobre o processo de integração, consulte o Guia do desenvolvedor para parceiros da Autodesk. 10 Manual de referência do serviço da Web

11 3 Visão geral do serviço PlaceOrder O serviço PlaceOrder expõe dois recursos de API para o gerenciamento de pedidos: /orders/fulfillment e /orders/revoke. Esses recursos são compostos de operações, que lidam com a criação do pedido, o cancelamento de pedido, as devoluções de pedido, as adições de licenças e produtos aos contratos existentes, bem como a remoção de licenças e produtos dos contratos existentes. Este documento incluirá os diversos cenários do serviço PlaceOrder que são elegíveis para a geração de pedido ou modificações do contrato no ambiente da Autodesk. Os detalhes dos serviços incluídos no atendimento de pedido e no processo de revogação de pedido podem ser encontrados abaixo. Enviando novo pedidos Adicionando licenças aos contratos existentes Adicionando produtos aos contratos existentes Removendo licenças de contratos existentes Removendo produtos de contratos existentes Devolvendo um contrato recorrente (indisponível no momento) Cancelando um contrato recorrente 11 Manual de referência do serviço da Web

12 3.1 Assinatura da Autodesk A assinatura da Autodesk é uma abordagem de pagamento pré-pago, com a opção de períodos mensal, trimestral, anual ou multianual selecionada por clientes. Há dois modelos principais: recorrente e renovável Em um modelo de assinatura recorrente, uma determinada assinatura do cliente é atualizada automaticamente, com base no período (mensal, trimestral ou anual) selecionado pelo parceiro. A assinatura não expira e somente será cancelada quando o cliente solicitar explicitamente ou alterar o modelo da assinatura em questão Renovável Quando os clientes assinam um serviço segundo o modelo renovável, a assinatura expirará após o término do período selecionado (trimestral, anual, multianual). Essa mesma assinatura pode ser renovada perto do final do período. Em resumo, as assinaturas renováveis têm uma data final associada a elas enquanto as recorrentes não têm nenhuma data final. 3.2 Atendimento do pedido O recurso da API de atendimento de pedido cuida da criação do pedido, adiciona licenças e adiciona operações do produto. As operações de adição de licença e de produto são somente para os contratos existentes. 3.3 Revogação de pedido O recurso da API de revogação de pedido cuida da operação de devolução de pedido para pedidos recorrentes, bem como as operações de remoção de licença, remoção de produto e cancelamento. As devoluções só são válidas no período de carência acordado. Se o retorno for válido, o contrato será cancelado e o valor reembolsado. Para a operação de cancelamento, o comportamento de renovação automática é encerrado. O contrato ainda é válido para o resto do prazo. As operações de remoção de licença e de produto são somente para os contratos existentes. 3.4 Mensagens SNS As Mensagens SNS são um serviço opcional que os Parceiros da Autodesk podem solicitar, o que lhes permite receber alertas sobre qualquer serviço de realização de pedidos. O parceiro receberá um alerta após a conclusão da transação. A mensagem no alerta indicará o status da transação. Ela exibirá a transação e indicará se o status é "Sucesso" ou "Falha". A mensagem SNS está disponível para todos os cenários de realização de pedidos para modelos recorrentes e renováveis. Se estiver inscrito para receber as notificações de conclusão de pedido, um Parceiro poderá escolher um dos três seguintes métodos de entrega: o o Mensagem SMS o Extremidade 12 Manual de referência do serviço da Web

13 3.5 Obtenção de status do pedido O recurso de API Obtenção de status do pedido retorna o status atual de um determinado pedido dado o número de referência obtido da resposta à API Fazer pedido. Há suporte para a API Obtenção de status do pedido para todos os serviços Fazer pedido dos cenários recorrentes e renováveis. Para obter o status da ordem de compra desejada, a ID da transação deve ser fornecida. 4 Informações de referência do serviço PlaceOrder Nota: a seção a seguir contém o Esquema de solicitação e resposta para o serviço PlaceOrder. A pergunta de quais campos são obrigatórios ou opcionais em cada um dos esquemas a seguir é determinada pelo uso de um parceiro de um dos dois modelos de assinaturas, renovável ou recorrente. Neste ponto, os Parceiros podem não enviar pedidos em uma combinação de modelos de assinatura e Renovável. Fazer isso retornará uma resposta de erro. 4.1 Atendimento do pedido Com base no campo action_name fornecido no corpo da solicitação, diferentes operações serão invocadas. Por exemplo, um action_name de "initial_order" especificará a opção para criar a opção de compra e "add_seats" especificará a opção para adicionar licenças. Abaixo está o esquema de solicitação para os casos nos quais o tipo de solicitação é para criação de licenças ou para adição de licenças ou produtos. O esquema de resposta associado também está incluído. Os valores de action_name esperados são os seguintes: initial_order, add_seats, add_products. 4.2 Esquema de solicitação - Criar pedido inicial Os detalhes dos campos esperados no corpo da solicitação estão localizados na tabela a seguir para Criação de pedido. Vamos exigir campos relacionados às informações de usuário final, de cliente e de produto. As linhas realçadas são elementos cujo valor é um objeto JSON ou uma Matriz que contém as informações nas linhas recuadas abaixo. Consulte a seção de mensagens de solicitação de amostra para consultar o agrupamento correto de campos. Se uma conta existir e o CSN correspondente for fornecido, os detalhes do cliente poderão ser recuperados dos sistemas da Autodesk. Se o CSN não for fornecido, os parceiros precisarão fornecer as informações, como nome, endereço e localização, para criar uma nova conta. Uma nota sobre a conclusão de pedido: quando os sistemas da Autodesk recebem um Pedido inicial de parceiro, as validações básicas para itens, como SKU, Contrato e Preço são concluídas antecipadamente na camada do Serviço da API PlaceOrder. Após isso, uma resposta é gerada e enviada para o Parceiro sobre o sucesso ou a falha da solicitação com um número de referência (que compõe uma concatenação de CSN, número da ordem de compra e carimbo de data e hora). Utilizar o Número de referência como entrada para a API GetOrderStatus permitirá que o Parceiro exiba o status da OC. Por fim, os sistemas da Autodesk atualizarão o status da transação de um status de processamento para um estado completo, assim que o Pedido em questão for criado no SAP. 13 Manual de referência do serviço da Web

14 Pedido Data do contrato Matriz do campo Definição do esquema Descrição do campo Exemplo EndUser Contact action_name opportunity_type opportunity_number po_date po_number Nome do evento que o parceiro realizará ao fazer pedido Tipo de oportunidade de vendas exclusivo, criado para um pedido ID exclusiva que faz referência a uma oportunidade de vendas que foi criada para um pedido Data em que o parceiro se eleva a OC no sistema interno (pode ser data do sistema ou data no passado) Número da ordem de compra a ser determinado pelo solicitante para identificar cada ordem "initial_order" A A /12/2009 ORD1234 customer_po_number Número da OC do cliente contract_start_date Data de início do contrato 25/12/2009 end_user first_name Nome do gerente de contratos (pessoa de contato) "John" Tipo de campo Formato de data ISO 8601 Formato de data ISO 8601 Matriz do Objeto JSON Máx. Caracteres Obrigatório/ Opcional (O/O) Comentários Renovação/ 13 R initial_order 1 O 15 O Os valores possíveis são A (ACE) e "R" (Renovação). Quando você fornece o opportunity_type ou o opportunity_number, é preciso fornecer o outro. 10 O 35 R 10 O R Quando contract_start_date é especificado, a data deve estar dentro de 30 dias a partir da data atual. Quando contract_start_date não é especificado, a data é a data atual. 35 R 14 Manual de referência do serviço da Web

15 last_name language primary_account_csn Sobrenome do gerente de contratos (pessoa de contato) do gerente de contratos (pessoa de contato) Preferência de idioma da pessoa de contato CSN da conta de usuário final "Smith" EN primary_account_name Nome da conta "Partner Inc1" primary_account_address_li ne1 primary_account_address_li ne2 primary_account_address_li ne3 primary_account_address_ci ty Linha 1 do endereço da conta Linha 2 do endereço da conta Linha 3 do endereço da conta Cidade da conta "1 Parkway Road" Departamento de engenharia Desk 5405 San Jose 35 R 80 R padrão 2 O 10 O É inglês como padrão quando não informado Forneça se souber, caso contrário, preencha os detalhes abaixo da conta principal primary_account_csn não seja fornecido primary_account_csn não seja fornecido primary_account_csn não seja fornecido primary_account_csn não seja fornecido primary_account_csn não seja fornecido 15 Manual de referência do serviço da Web

16 primary_account_address_s tate primary_account_address_c ountry_code primary_account_address_p ostal_code related_account_csn related_account_name related_account_address_lin e1 related_account_address_lin e2 related_account_address_lin e3 Estado da conta Código do país da conta "CA" "US" CEP da conta CSN da conta para o qual o gerente de contratos está associado (poderia ser o mesmo ou outro) Nome da conta à qual o gerente de contratos está associado Linha 1 do endereço da conta relacionada Linha 2 do endereço da conta relacionada Linha 3 do endereço da conta relacionada "Partner Inc" "1 Parkway Road" Departamento de engenharia Desk O primary_account_csn não seja fornecido primary_account_csn não seja fornecido. Código ISO de 2 dígitos primary_account_csn não seja fornecido Forneça se souber, caso contrário, preencha os detalhes abaixo da conta relacionada related_account_csn não seja fornecido related_account_csn não seja fornecido related_account_csn não seja fornecido related_account_csn não seja fornecido 16 Manual de referência do serviço da Web

17 related_account_address_cit y related_account_address_st ate related_account_address_c ountry_code related_account_address_p ostal_code Cidade da conta relacionada Estado da conta relacionada Código do país da conta relacionada San Jose "CA" "US" CEP da conta relacionada related_account_csn não seja fornecido related_account_csn não seja fornecido related_account_csn não seja fornecido. Código ISO de 2 dígitos related_account_csn não seja fornecido Reseller Party reseller_account_csn CSN da conta relacionada R Parceiro do DL SoldToParty sold_to_account_csn CSN da conta Vendido para O Parceiro vendido para CSN. Caso não seja fornecido, receberá o valor do cabeçalho de autorização. other_parties account_csn CSN da conta da pessoa (por exemplo, agente de encaminhamento) Matriz do Objeto JSON R Renovação 10 R Renovação partner_type Os valores a serem inseridos são somente "ForwardingAgent" ForwardingAgent 18 R Renovação 17 Manual de referência do serviço da Web

18 ListOfLineItems line_items subscription_id No caso de pedido recorrente, para identificar de forma única cada linha de produtos, uma única ID SUBS é gerada por linha de produtos. A mesma assinatura. A ID precisa ser referenciada ao realizar as transações subsequentes, como adicionar licenças da mesma linha de produtos ao mesmo contrato "845cd4b7-2f20-4c1aaaa " part_number SKU 001G1-WW7929-T210 quantity Quantidade 1 net_amount Valor "39.33" delivery_method eu_first_name Valor do método de entrega a ser aprovado ED Nome do coordenador de software (pessoa de contato) ED "Peter" Matriz do Objeto JSON Número inteiro positivo R 36 R 35 R R Formato da versão 4 do UUID. SKUNumber -> part_number 20 R - R Renovação 40 R eu_last_name Sobrenome do coordenador de software (pessoa de contato) "longslide" 40 R eu_ eu_language eu_country do coordenador de software (pessoa de contato) Idioma de preferência do coordenador de software para comunicações Código de país do coordenador de software Peter.longslide@sttest.co m "EN" "US" 80 R Padrão: 2 R Código ISO de 2 dígitos 2 R Código ISO de 2 dígitos 18 Manual de referência do serviço da Web

19 eu_primary_account_csn eu_primary_account_name eu_primary_account_addres s_line1 eu_primary_account_addres s_line2 eu_primary_account_addres s_line3 eu_primary_account_addres s_city eu_primary_account_addres s_state CSN da conta à qual o coordenador de software está associado, neste cenário em que o coordenador de software de uma determinada linha de produtos é diferente do gerente de contratos Nome da conta à qual o Coordenador de software está associado Linha 1 do endereço da conta do coordenador de software Linha 2 do endereço da conta do coordenador de software Linha 3 do endereço da conta do coordenador de software Cidade da conta do coordenador de software Estado da conta do coordenador de software "Partner Inc1" "1 Parkway Road" Departamento de engenharia Desk 5405 San Jose "CA" 10 O Forneça se souber, caso contrário, preencha os detalhes abaixo de eu_primary_account eu_primary_account_csn não seja fornecido eu_primary_account_csn não seja fornecido eu_primary_account_csn não seja fornecido eu_primary_account_csn não seja fornecido eu_primary_account_csn não seja fornecido eu_primary_account_csn não seja fornecido 19 Manual de referência do serviço da Web

20 eu_primary_account_addres s_country_code Código do país da conta do coordenador de software "US" eu_primary_account_csn não seja fornecido. Código ISO de 2 dígitos eu_primary_account_addres s_postal_code CEP da conta do coordenador de software eu_primary_account_csn não seja fornecido 20 Manual de referência do serviço da Web

21 Agora a carga pode ser de dois tipos. Se o CSN da conta principal, o CSN da conta relacionada ou eu_primary_account_csn for informado, será possível criar a carga como mostrado na versão aprimorada abaixo Carga existente do pedido inicial Carga aprimorada do pedido inicial 21 Manual de referência do serviço da Web

22 4.3 Esquema de solicitação Adicionar licenças Matriz do campo Definição do esquema Descrição do campo Exemplo action_name Nome do evento que o parceiro realizará ao fazer pedido, como adicionar licença. "add_seats" contract_number Número do contrato/acordo " " po_date po_number Data em que o parceiro se eleva a OC no sistema interno (pode ser data do sistema ou data no passado) Número da ordem de compra a ser determinado pelo solicitante para identificar cada ordem Tipo de campo Sequência de Sequência de Máx. de Obrigatório/ Opcional (O/O) 22 Manual de referência do serviço da Web Comentários Renovação/ 9 R "add_seats" 12 R " " Data 10 O " " customer_po_number Número da OC do cliente contract_start_date Data de início do contrato net_amount Valor total (soma dos valores em itens de linha) "105.32" reseller_account_csn CSN da conta do revendedor " " Sequência de Sequência de Formato de data ISO 8601 Sequência de Sequência de 35 R 10 O 20 R Quando contract_start_ date é especificado, a data deve estar dentro de 30 dias a partir da data atual. Quando contract_start_ date não é especificado, a data é a data atual. Soma de todos os line_items Renovação 10 R Renovação

23 line_items sold_to_account_csn CSN da conta Vendido para opportunity_type opportunity_number line_items subscription_id item_start_date Tipo de oportunidade de vendas exclusivo, criado para um pedido ID exclusiva que faz referência a uma oportunidade de vendas que foi criada para um pedido No caso de pedido recorrente, para identificar de forma única cada linha de produtos, uma única ID SUBS é gerada por linha de produtos. A mesma assinatura. A ID precisa ser referenciada ao realizar as transações subsequentes, como adicionar licenças da mesma linha de produtos ao mesmo contrato Data em que inicia a cobrança desta adição de licença A A "914fadc9-2b67-476eb480-e0e232e98745" part_number SKU "321K T979" quantity Quantidade 7 Sequência de Sequência de Sequência de Matriz de objetos JSON Sequência de 10 O 1 O 15 O R 36 R Caso não seja fornecido, receberá o valor do cabeçalho de autorização. Os valores possíveis são A (ACE) e "R" (Renovação). Quando você fornece o opportunity_typ e ou o opportunity_nu mber, é preciso fornecer o outro. formatada UUID versão 4 Renovação " " Data 10 O Renovação Sequência de Número inteiro positivo 35 R R 23 Manual de referência do serviço da Web

24 eu_ eu_first_name eu_last_name do coordenador de software (pessoa de contato) Nome do coordenador de software (pessoa de contato) Sobrenome do coordenador de software (pessoa de contato) "John" "Smith" net_amount Valor "105.32" serial_numbers Número de série [" "] Sequência de Sequência de Sequência de Sequência de Matriz de sequências de 80 R Renovação 40 R Renovação 40 R Renovação 20 R R Valor líquido por line_item Renovação 4.4 Esquema de solicitação Adicionar produtos Matriz do campo Definição do esquema Descrição do campo Exemplo Tipo de campo Máx. de Obrigatório/ Opcional (O) Comentários Renovação/ action_name Nome do evento que o parceiro realizará, como adicionar produtos "add_products" contract_number Número do contrato/acordo " " po_number net_amount Número da ordem de compra a ser determinado pelo solicitante para identificar cada ordem Valor total (soma dos valores em itens de linha) " " "105.32" 12 R "add_products" 12 R 35 R 20 R Soma de todos os line_items 24 Manual de referência do serviço da Web

25 po_date Data em que o parceiro se eleva a OC no sistema interno (pode ser data do sistema ou data no passado) customer_po_number Número da OC do cliente contract_start_date Data de início do contrato reseller_account_csn CSN da conta do revendedor sold_to_account_csn CSN da conta Vendido para opportunity_type opportunity_number Tipo de oportunidade de vendas exclusivo, criado para um pedido ID exclusiva que faz referência a uma oportunidade de vendas que foi criada para um pedido " " Data 10 O A A Formato de data ISO 8601 Padroniza de acordo com a data do sistema 10 O Quando contract_start_date é especificado, a data deve estar dentro de 30 dias a partir da data atual. Quando contract_start_date não é especificado, a data é a data atual. Renovação 10 R Renovação 10 O 1 O 15 O Caso não seja fornecido, receberá o valor do cabeçalho de autorização. Os valores possíveis são A (ACE) e "R" (Renovação). Quando você fornece o opportunity_type ou o opportunity_numbe r, é preciso fornecer o outro. Renovação 25 Manual de referência do serviço da Web

26 line_items line_items subscription_id No caso de pedido recorrente, para identificar de forma única cada linha de produtos, uma única ID SUBS é gerada por linha de produtos. A mesma assinatura. A ID precisa ser referenciada ao realizar as transações subsequentes, como adicionar licenças da mesma linha de produtos ao mesmo contrato "914fadc9-2b67-476eb480-e0e232e98745" part_number SKU "321K T868" quantity Quantidade 7 item_start_date eu_ Data em que inicia a cobrança desta adição de licença do coordenador de software (pessoa de contato) Matriz de objetos JSON Número inteiro positivo R 36 R formatada UUID versão 4 35 R R " " Data 10 O Renovação "admin@autodesk.com" 80 R Renovação eu_first_name Nome do coordenador de software (pessoa de contato) "John" 40 R Renovação eu_last_name Sobrenome do coordenador de software (pessoa de contato) "Smith" 40 R Renovação end_user Objeto JSON O first_name last_name Nome do gerente de contratos (pessoa de contato) Sobrenome do gerente de contratos (pessoa de contato) do gerente de contratos (pessoa de contato) "John" "Smith" john@autodesk.com 35 R 35 R 80 R 26 Manual de referência do serviço da Web

27 language Preferência de idioma da pessoa de contato EN primary_account_csn CSN da conta de usuário final " " primary_account_name Nome da conta "Arthur Doe" primary_account_address_line1 Linha 1 do endereço da conta "1 Parkway Road" primary_account_address_line2 Linha 2 do endereço da conta Departamento de engenharia primary_account_address_line3 Linha 3 do endereço da conta Desk 5405 primary_account_address_city Cidade da conta San Jose primary_account_address_state Estado da conta "CA" primary_account_address_countr y_code primary_account_address_postal _code Código do país da conta "US" CEP da conta O 10 O 3 O 3 O 9 O É inglês como padrão quando não informado Forneça se souber, caso contrário, preencha os detalhes abaixo da conta principal primary_account_c sn não seja fornecido primary_account_c sn não seja fornecido primary_account_c sn não seja fornecido primary_account_c sn não seja fornecido primary_account_c sn não seja fornecido primary_account_c sn não seja fornecido primary_account_c sn não seja fornecido. Código ISO de 2 dígitos primary_account_c sn não seja fornecido 27 Manual de referência do serviço da Web

28 net amount Valor "105.32" 20 R Valor líquido por line_item 4.5 Esquema de solicitação Renovar Matriz do campo Definição do esquema Descrição do campo Exemplo action_name Nome do evento que o parceiro realizará ao fazer pedido, como renovar "renew" Tipo de campo Máx. de Obrigatório/ Opcional (O) Comentários Renovação/ 5 R "renew" Renovação order_date Data na qual o pedido é enviado " " Data 10 O Renovação po_date Data em que o parceiro se eleva a OC no sistema interno (pode ser data do sistema ou data no passado) " " Data 10 O Renovação po_number Número da ordem de compra a ser determinado pelo solicitante para " " identificar cada ordem 35 R Renovação customer_po_number Número da OC do cliente Renovação contract_number Número do contrato/acordo " " 12 R Renovação reseller_account_csn CSN da conta do revendedor sold_to_account_csn CSN da conta Vendido para R Renovação 10 O Caso não seja fornecido, receberá o valor do cabeçalho de autorização. Renovação 28 Manual de referência do serviço da Web

29 opportunity_type opportunity_number line_items Tipo de oportunidade de vendas exclusivo, criado para um pedido ID exclusiva que faz referência a uma oportunidade de vendas que foi criada para um pedido A A Matriz de objetos JSON 1 O 15 O R Os valores possíveis são A (ACE) e "R" (Renovação). Quando você fornece o opportunity_typ e ou o opportunity_nu mber, é preciso fornecer o outro. Renovação Renovação Renovação line_items part_number SKU "123K T979" quantity Quantidade 7 net_amount Valor "105.32" serial_numbers Número de série [" "] Número inteiro positivo Matriz de sequências de 35 R Renovação R 20 R R Valor líquido por line_item Renovação Renovação Renovação 29 Manual de referência do serviço da Web

30 4.6 Atualizar ordem de compra recorrente O recurso da API Atualizar ordem de compra recorrente gerencia a atualização de um número de OC de uma cobrança recorrente. A API Atualizar ordem de compra recorrente pode ser utilizada apenas por parceiros que tenham assinado um modelo recorrente. Essa assinatura será renovada automaticamente dentro do intervalo selecionado (trimestral, anual, multianual) e o pedido que estiver em aberto no momento será atualizado com um novo número de OC e, consequentemente, uma nova cobrança recorrente. Para que as atualizações possam ser aplicadas, o pedido deverá ser incluído na cobrança recorrente agendada no mínimo com 48 horas de antecedência. 4.7 Esquema de solicitação Atualizar ordem de compra recorrente Nota: o esquema a seguir se aplica somente aos parceiros que usam um modelo de assinatura recorrente. Descrição do campo Definição do esquema action_name Exemplo "po_update" contract_number po_number Tipo de campo Comprimento 9 Comentários Deve ser sempre po_update 30 Obrigatório brigatório 4.8 Obtenção de status do pedido O micro serviço Obtenção de status do pedido é uma solicitação de obtenção simples no seguinte formato: o qual possui um único campo no esquema de solicitação descrito abaixo. O esquema de resposta associado, um status de sucesso ou falha, também é incluído. Descrição do campo Caminho da URL 4.9 Esquema de solicitação Obtenção de status do pedido [apenas para um pedido inicial recorrente] Definição do esquema reference number Exemplo /order/status/ Tipo de campo Sequência de Comprimento Mín. 20 Máx. 40 Comentários Obrigatório. Parte do caminho da URL 30 Manual de referência do serviço da Web

31 4.10 Revogação de pedido Abaixo está o esquema de solicitação para os casos nos quais o tipo de solicitação é para remoção de licença, remoção de produto, cancelamento de pedido ou devoluções de pedido. O esquema de resposta associado também está incluído. As solicitações de revogação de pedido só estão disponíveis para os Parceiros que utilizam um modelo de assinatura. No momento, as devoluções de pedido não estão disponíveis e serão lançadas como melhoria futura. Os valores de action_name esperados são: remover licenças, remover produtos, cancelar Esquema de solicitação Remover licenças, remover produtos, cancelamento de pedido Os detalhes dos campos esperados no corpo da solicitação para as modificações em um pedido existente, como reduzir a quantidade de licenças para remover outro produto estão localizadas na tabela a seguir. Nota: o esquema a seguir se aplica somente aos parceiros que usam um modelo de assinatura recorrente. No momento, um esquema do modelo de assinatura renovável não está disponível. Descrição do campo Cabeçalho do contrato Nível do item de linha Definição do esquema action_name Exemplo "remover licenças" contract_number line_items subscription_id "bac19ced- 7aa a c8e98d" quantity 3 Tipo de campo Sequência de Sequência de Matriz de objetos JSON Sequência de Número inteiro positivo Obrigatório/ opcional Comprimento R 15 Comentários remover licenças, remover produtos, cancelar R 30 Obrigatório R R 36 R 13 Não necessário para cancelamento Não necessário para cancelamento Só é necessário para remover licenças. Número de licenças a serem removidas 31 Manual de referência do serviço da Web

32 4.12 Esquema de resposta - Criar pedido inicial Uma resposta simples da API que verifica se uma chamada passou por autenticação, autorização e validações e se ela está sendo processada em nossos sistemas de back-end. Definição do esquema Exemplo Tipo de campo status "OK" mensagem "Seu pedido está sendo processado." número de referência Esquema de resposta Atualizar ordem de compra recorrente Uma resposta simples da API que verifica se uma chamada passou por autenticação, autorização e validações e se ela está sendo processada em nossos sistemas de back-end. Definição do esquema Exemplo Tipo de campo status "FALHOU" mensagem "O número de contrato não existe" Não é possível adicionar licenças a um produto cancelado com a ID de assinatura <Subs ID> número de referência Esquema de responsta Obtenção de status do pedido A resposta da API de status retorna o status da ordem de acordo com a ID da transação fornecida. O status indicará se o pedido está em processamento, foi concluído ou falhou com um número de caso do código de status. Definição do esquema status mensagem última atualização Exemplo "OK", FALHA, Pedido aceito Pedidos em processamento O pedido foi criado com êxito. Erro no processamento do pedido. Entre em contato com a Autodesk (código de erro 71) Erro no processamento do pedido. Entre em contato com a Autodesk CASE# " :15:54 UTC" Tipo de campo 32 Manual de referência do serviço da Web

33 4.15 Esquema de resposta - Remover licença, Remover produto, Cancelamento de pedido [somente ] Uma resposta simples da API que verifica se uma chamada passou por autenticação, autorização e validações e se ela está sendo processada em nossos sistemas de back-end. Definição do esquema Exemplo Tipo de campo status "FALHOU" mensagem "A SKU não está ativa" número de referência Esquema de resposta Notificação de SNS Abaixo estão os itens presentes na resposta de uma notificação de SNS. A resposta fornece detalhes sobre o status do pedido realizado. Se for bem-sucedido, o número da entidade será preenchido com o número do pedido de vendas dos nossos sistemas de back office. Caso tenha ocorrido um erro ao processar o pedido, o campo de mensagem fornecerá um código de erro. Definição do esquema Exemplo Tipo de campo csn " " transaction_id " status "Sucesso", "Falha" mensagem O pedido foi criado com êxito. O pedido de adição de licença foi atualizado com êxito. Erro no processamento do pedido. Entre em contato com a Autodesk (código de erro 71) entity_number Manual de referência do serviço da Web

34 5 Amostra de mensagens 5.1 Mensagem de solicitação Atendimento de pedidos, Pedido inicial, Modelo de assinatura recorrente Message Headers Authorization: Bearer <<Access Token>> Content-Type: application/json CSN: <<CSN>> Body "action_name": "initial_order", "po_number": " ", "customer_po_number": " ", "opportunity_type": A, opportunity_number : A , "end_user": "first_name": "Gitman ", "last_name": "Gitman ", " ": "GitmanSan @ssttest.net", "language": "EN", "country": "US", "primary_account_name": "Corp Account1", "primary_account_address_line1": "500 Las Gallinas Ave", primary_account_address_line2 : Engineering Dept., primary_account_address_line3 : Office 5342, "primary_account_address_city": "San Rafael", "primary_account_address_state": "CA", "primary_account_address_country_code": "US", "primary_account_address_postal_code": "94903", "related_account_name": "Corp Account1", "related_account_address_line1": "400 Las Gallinas Ave", related _account_address_line2 : Engineering Dept., related _account_address_line3 : Office 5342, "related_account_address_city": "San Rafael", "related_account_address_state": "CA", "related_account_address_country_code": "US", "related_account_address_postal_code": "94903", 34 Manual de referência do serviço da Web

35 "reseller_account_csn": " ", "line_items": [ "subscription_id": "845cd4b7-2f20-4c1a-aaa ", "part_number": "767F T279", "quantity": 1, "net_amount": "264.00", "eu_first_name": "Gitman ", "eu_last_name": "Gitman ", "eu_ ": "Gitman @ssttest.net", "eu_language": "EN", "eu_country": "US", "eu_primary_account_name": "Gitman Corp Accoun1", "eu_primary_account_address_line1": "600 Las Gallinas Ave", "eu_primary_account_address_city": "San Rafael", "eu_primary_account_address_state": "CA", "eu_primary_account_address_country_code": "US", "eu_primary_account_address_postal_code": "94903" ] Mensagem de resposta Atendimento de pedidos, Pedido inicial "status": "OK", "message": "Your order is being processed", "reference number": " INITIAL ORDER 9-27 arc " 35 Manual de referência do serviço da Web

36 5.2 Mensagem de solicitação Atendimento de pedidos, Pedido inicial, Modelo de assinatura renovável Message Headers Authorization: Bearer <<Access Token>> Content-Type: application/json CSN: <<CSN>> Body "action_name": "initial_order", "po_date": " ", "po_number": "SSDD-002", "customer_po_number": "initial custpo", "end_user": " ": "first_name": "Rawr", "last_name": "Stein", "primary_account_name": "Rawrstein World", "primary_account_address_line1": "666 Mars Way", "primary_account_address_city": "San Rafael", "primary_account_address_county": "United States", "primary_account_address_country_code": "US", "primary_account_address_geo": "NAMER", "primary_account_address_postal_code": "94903", "primary_account_address_state": "CA", "related_account_name": "Rawrstein World", "related_account_address_line1": "666 Mars Way", "related_account_address_city": "San Rafael", "related_account_address_county": "United States", "related_account_address_country_code": "US", "related_account_address_geo": "NAMER", "related_account_address_postal_code": "94903", "related_account_address_state": "CA", 36 Manual de referência do serviço da Web

37 "reseller_account_csn": " ", "ship_to_party_account_name": "Rawrstein World", "ship_to_party_address_line1": "666 Mars Way", "ship_to_party_address_city": "San Rafael", "ship_to_party_address_county": "United States", "ship_to_party_address_country_code": "US", "ship_to_party_address_geo": "NAMER", "ship_to_party_address_postal_code": "94903", "ship_to_party_address_state_code": "CA", "sold_to_account_csn": " ", "other_parties": [ "account_csn": " ", "partner_type": "ForwardingAgent" ], "line_items": [ "part_number": "978G1-WW2859-T981", "quantity": 1, "net_amount": "1570.8", "delivery_method": "ED", "part_number": "978G1-WW6919-T229", "quantity": 1, "net_amount": "1293.6", "delivery_method": "ED" ] Mensagem de resposta Atendimento de pedidos, Pedido inicial "status": "OK", "message": "Your order is being processed", "reference number": " INITIAL ORDER 9-27 arc " 37 Manual de referência do serviço da Web

38 5.3 Mensagem de solicitação Atendimento de pedidos, Adicionar licenças, Modelo de assinatura recorrente Message Headers Authorization: Bearer <<Access Token>> Content-Type: application/json CSN: <<CSN>> Body "action_name": "add_seats", "contract_number": " ", "po_number": " ", "net_amount": "105.32", "line_items": [ "subscription_id": "173789c1-d4b1-4bda-aaa1-8b3ea18ee53e", "part_number": "123F T979", "quantity": 3, "net_amount": "105.32", "subscription_id": "173789c1-d4b1-4bda-aaa1-8b3ea18ee53e", "part_number": "123F T970", "quantity": 2, "net_amount": "105.32" ] Mensagem de resposta Atendimento de pedidos, Adicionar licenças, Modelo de assinatura recorrente "status": "OK", "message": "Your order is being processed", "reference number": " INITIAL ORDER 9-27 arc " 38 Manual de referência do serviço da Web

39 5.4 Mensagem de solicitação Atendimento de pedidos, Adicionar licenças, Modelo de assinatura renovável Message Headers Authorization: Bearer <<Access Token>> Content-Type: application/json CSN: <<CSN>> Body "action_name": "add_seats", "po_date": " ", "po_number": "adds-mp-001", "customer_po_number": "adds s.s.d.d.", "contract_number": " ", "net_amount": "2864.4", "pricing_date": " ", "reseller_account_csn": " ", "ship_to_party_account_csn": " ", "sold_to_account_csn": " ", "line_items": [ "item_start_date": " ", "part_number": "978G T761", "quantity": 1, "related_account_csn" : " ", "net_amount": "1570.8", "serial_numbers": [ " " ], "item_start_date": " ", "part_number": "978G T204", "quantity": 1, "related_account_csn" : " ", "net_amount": "1293.6", "serial_numbers": [ " " ] ] 39 Manual de referência do serviço da Web

40 5.4.1 Mensagem de resposta Atendimento de pedidos, Adicionar licenças, Modelo de assinatura renovável "status": "OK", "message": "Your order is being processed", "reference number": " INITIAL ORDER 9-27 arc " 5.5 Mensagem de solicitação Atendimento de pedidos, Adicionar produtos, Modelo de assinatura recorrente Message Headers Authorization: Bearer <<Access Token>> Content-Type: application/json CSN: <<CSN>> Body "action_name": "add_products", "contract_number": " ", "po_number": "ae9be-3205ec9a9f3b", "net_amount": "264.0", "line_items": [ "subscription_id": "fa724c53-a376-4ab4-9a ec9a9f3b", "part_number": "767F T826", "quantity": 2, "net_amount": "264.0", "end_user": "first_name": "ddwsman ", "last_name": "ddwsman ", " ": "ddwsman @ssttest.net", "language": "EN", "country": "US", "primary_account_name": "ddwsman Corp Account1", "primary_account_address_line1": "810 Civic Center Dr", "primary_account_address_city": "San Rafael", "primary_account_address_state": "CA", "primary_account_address_country_code": "US", "primary_account_address_postal_code": "94903" ] 40 Manual de referência do serviço da Web

41 5.5.1 Mensagem de resposta Atendimento de pedidos, Adicionar produtos, Modelo de assinatura recorrente "status": "OK", "message": "Your order is being processed", "reference number": " INITIAL ORDER 9-27 arc " 5.6 Mensagem de solicitação Atendimento de pedidos, Adicionar produtos, Modelo de assinatura renovável Message Headers Authorization: Bearer <<Access Token>> Content-Type: application/json CSN: <<CSN>> Body "action_name": "add_products", "po_date": " ", "po_number": "de2398-addp-002", "contract_number": " ", "customer_po_number": "addp s.s.d.d.", "net_amount": "1570.8", "pricing_date": " ", "reseller_account_csn": " ", "ship_to_party_account_csn": " ", "sold_to_account_csn": " ", "line_items": [ "item_start_date": " ", "part_number": "978G1-WW2859-T981", "quantity": 1, "eu_ ": "rawr.stein@ .com", "eu_first_name": "Rawr", "eu_last_name": "Stein", "related_account_csn": " ", "net_amount": "1570.8" ] 41 Manual de referência do serviço da Web

42 5.6.1 Mensagem de resposta Atendimento de pedidos, Adicionar produtos, Modelo de assinatura renovável "status": "OK", "message": "Your order is being processed", "reference number": " INITIAL ORDER 9-27 arc " 42 Manual de referência do serviço da Web

43 5.7 Mensagem de solicitação Atendimento de pedidos, Renovação, Modelo de assinatura renovável somente Message Headers Authorization: Bearer <<Access Token>> Content-Type: application/json CSN: <<CSN>> Body "action_name": "renew", "po_date": " ", "po_number": "SSDD-RENEW-02", "contract_number": " ", "net_amount": "1293.6", "pricing_date": " ", "reseller_account_csn": " ", "ship_to_party_account_csn": " ", "sold_to_account_csn": " ", "opportunity_type": A, opportunity_number : A ", "line_items": [ "part_number": "978G T374", "quantity": 1, "eu_ ": "rawr.stein@ .com", "eu_first_name": "Rawr", "eu_last_name": "Stein", "related_account_csn": " ", "net_amount": "1293.6", "serial_numbers": [ " " ] ] 43 Manual de referência do serviço da Web

44 5.7.1 Mensagem de resposta Atendimento de pedidos, Renovação, Modelo de assinatura renovável somente "status": "OK", "message": "Your order is being processed", "reference number": " INITIAL ORDER 9-27 arc " 5.8 Mensagem de solicitação Atualizar ordem de compra recorrente Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> "action_name":"po_update", "contract_number":" ", "po_number":" " Mensagem de resposta Atualizar ordem de compra recorrente "status": "OK", "message": "Your order is being processed", "reference number": " " 5.9 Mensagem de solicitação Obtenção de status do pedido Mensagem de resposta Obtenção de status do pedido "status": "Order Accepted", "message": "Order was created successfully.", "last_updated": " :21:54 UTC" 44 Manual de referência do serviço da Web