Serviç os da rede de distribuiç ã o digital (DDWS) GetLicense - … · 6 | Manual de referê...

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

2 | Manual de referê ncia do serviç o da Web

Í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 ......................................................................................................................... 3

3 Visão geral do serviço GetLicense ................................................................................... 3

3.1 Limitações ................................................................................................................. 5

3.2 Vantagens ................................................................................................................. 5

4 Informações de referência do serviço GetLicense ............................................................ 5

4.1 Esquema de solicitação ............................................................................................. 5

4.2 Esquema de resposta ................................................................................................ 6

4.3 Esquema de erro ....................................................................................................... 7

4.4 Mensagem de solicitação .......................................................................................... 8

4.5 Mensagem de resposta ............................................................................................. 9

4.6 Mensagens de erro .................................................................................................. 10

4.6.1 Amostra de resposta de erro............................................................................. 11

Histórico de revisão

Versão Data Autor Comentários

2.1.2 2016-10-24 SJ URLs atualizados na seção 4.4

2.1.1 2016-07-01 CC Alterações na marca de revisão inicial da versão 2


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) no 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 parceiros da Autodesk.

3 Visão geral do serviço GetLicense

A finalidade deste serviço é recuperar as informações do recurso para determinado(s) número(s) de série ou para uma combinação de código(s) de linha de produto e de número(s) de série.


Este serviço faz e fornece o seguinte:

Obtém as informações do recurso com base no(s) número(s) de série ou em

uma combinação de código(s) de linha de produto e número(s) de série.

Capacidade de validar as informações da licença antes do envio do pedido.

A implementação de uma única amostra de pesquisa de recurso é mostrada abaixo. Nota: esta é uma amostra de interface do usuário


3.1 Limitações

O serviço atual tem as seguintes limitações:

1. Recurso manual e pesquisa de licença.

2. Imprecisão da transação.

3. Integração de negócios e problemas de EDI.

4. Maior tempo de processamento de pedidos.

3.2 Vantagens

O serviço GetLicense fornecerá os seguintes benefícios:

1. Um serviço da Web REST leve que podem ser consumido facilmente em qualquer

aplicativo por meio de uma conexão HTTP(s).

2. Flexibilidade para os Parceiros obterem informações do recurso com determinado(s)

número(s) de série ou fornecendo a combinação de código(s) de linha de produto e

número(s) de série.

3. Os Parceiros podem obter as informações do recurso para vários números de série

em uma única solicitação.

4. Recurso automático e pesquisa de licença.

5. Verificando informações do pedido antecipadamente.

6. Precisão da transação.

7. Integração de negócios mais rápida.

8. Acessando informações diretamente dos sistemas da ADSK.

9. Menor tempo de processamento de pedidos.

10. Consultas manuais automáticas.

4 Informações de referência do serviço GetLicense

4.1 Esquema de solicitação

Elemento Tipo de campo Comprimento/formato

de entrada Utilização

Código de linha de produto

Sequência de caracteres

Comprimento: máx. 40 caracteres

Opcional

Número de série Sequência de

caracteres Comprimento:

máx. 12 caracteres Obrigatório


4.2 Esquema de resposta

A tabela abaixo mostra os campos de resposta, com base no tipo de parceiro.

Não distribuidor / Não revendedor de registro

Distribuidor Revendedor

GetLicenseResponse/License*



contract_number contract_number contract_number

asset_subscription_start_date asset_subscription_start_date asset_subscription_start_date

asset_subscription_end_date asset_subscription_end_date asset_subscription_end_date

contract_end_date contract_end_date contract_end_date

contract_start_date contract_start_date contract_start_date

group_number group_number group_number

euaccountame euaccountame euaccountame

euaccount_number euaccount_number euaccount_number

implementação implementação implementação

descrição descrição descrição

group_name group_name group_name

ID ID ID

license_behavior license_behavior license_behavior

license_type license_type license_type

part_number part_number part_number

product_key product_key product_key

product_line product_line product_line

product_line_code product_line_code product_line_code

registered_date registered_date registered_date

licenças licenças licenças

serial_number serial_number serial_number

status status status

subscription_flag subscription_flag subscription_flag

usage_type usage_type usage_type

NA contact_emailaddress contact_emailaddress

subscription_program_type subscription_program_type subscription_program_type

NA contact_first_name contact_first_name

NA contact_last_name contact_last_name

recent_activation_date recent_activation_date recent_activation_date

licensing_model licensing_model licensing_model

NA contract_term contract_term

NA account_address account_address


relationship_from/relationship




product_name product_name product_name




relationship_to/relationship relationship_to/relationship relationship_to/relationship


product_name product_name product_name




Se um dos serialnumber_productlinecode não existir, a matriz da mensagem conterá um objeto JSON para indicar que um resultado não foi encontrado. O objeto JSON terá os seguintes campos.

Não distribuidor / Não revendedor de registro

Distribuidor Revendedor


error_code error_code error_code

error_message error_message error_message

As descrições para quando uma entrada serialnumber_productlinecode não for encontrada são indicadas abaixo.

Mensagem de erro Código de erro Descrição do erro

Número de série não encontrado nos sistemas da Autodesk.

SOA-License-006 Indica que, para um dos números de série fornecidos, não foram encontrados resultados.

4.3 Esquema de erro

Nome do campo Descrição

status Resposta de confirmação: "OK", "Erro"

mensagem Mensagem de falha ou erros

error_code Código de erro associado a mensagem de erro

error_message Descrição da causa da resposta de erro

transaction_id ID exclusivo de transação (combinação de LIC, número de série e registro de data e hora)


4.4 Mensagem de solicitação

Abaixo estão as solicitações de amostra para a operação GetLicense. Os Parceiros podem obter informações do recurso para vários números de série, números de série únicos e combinações de número(s) de série e código(s) de linha de produto, conforme especificado nas solicitações de amostra abaixo.

http://enterprise-api-qa.autodesk.com/v2/license?serialnumber_productlinecode=345-99809632,345-99809632|CIV3D Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>> OR http://enterprise-api-qa.autodesk.com/v2/license?serialnumber_productlinecode=345-99809632,345-99809632 Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>> OR http://enterprise-api-qa.autodesk.com/v2/license?serialnumber_productlinecode=345-99809632|CIV3D 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 Mensagem de resposta

{ "status": "OK", "transaction_id": "LIC701765101433844843", "message": [ { "contract_number": "765100009876", "asset_subscription_start_date": "07/16/2016", "asset_subscription_end_date": "Auto-Renewing Contract", "contract_end_date": " Auto-Renewing Contract", "contract_start_date": "06/06/2016 ", "euaccountame": "Panini Adam", "euaccount_number": "5102888078", "deployment": "Standalone", "description": "AutoCAD Civil 3D 2007 English, International", "license_behavior": "Term Extendable", "license_type": "Upgrade", "part_number": "23704-051452-9780", "product_key": "25554", "product_line": "Autodesk AutoCAD", "product_line_code": "CIV3D", "registered_date": "05/19/2007", "seats": "1", "serial_number": "345-99999632", "status": "Registered", "subscription_flag": "false", "usage_type": "Education Market Ready", "list_of_message": null, "relationship_from": { "relationship": [ { "product_name": "autodesk 3dxmax 2016 Non-Language Specific", "seats": "1", "serial_number": "345-99809632", "status": "Upgraded", } ], }, "relationship_to": { "relationship": [ { "product_name": "autodesk 3dxmax 2016 Non-Language Specific", "seats": "1",


"serial_number": "345-99809632", "status": "Registered", } ], }, "contact_emailaddress": "[email protected]", "subscription_program_type": null, "contact_first_name": "Adam", "contact_last_name": "Panini", "licensing_model": null, "contract_term": “A02”, "account_address": "6/8 Newhaven Road, Nowhereshire, EH6 5PU, United Kingdom" } ] }

4.6 Mensagens de erro

A tabela a seguir mostra os códigos de erro e as respectivas mensagens de erro mostradas na resposta mensagens, se houver erros:

Mensagem de erro Código de erro

Descrição do erro

Insira o Número de série. UAN-GEN-00108

Esta mensagem de erro será gerada quando o Número de série estiver vazio ou for nulo.

O Número de série não pode ter mais de 12 caracteres. Verifique sua entrada e tente novamente.

UAN-GEN-00123

Esta mensagem de erro será gerada quando o comprimento do vaor de Número de série tiver mais de 12 caracteres.

O Número de série contém caracteres inválidos. Verifique sua entrada e tente novamente.

UAN-GEN-00119

Esta mensagem de erro será gerada se o Número de série for informado com caracteres especiais diferentes de '-'. Exemplo de Número de série inválido: 341-*%^@#$@#$ADGH


O Número de série não tem formato válido. Verifique sua entrada e tente novamente.

UAN-GEN-00119

Este erro será gerado se o Número de série não tiver '-'. Exemplo de Número de série inválido: 39135980978.

A quantidade de números de série não deve exceder mais de 20 na solicitação.

UAN-LIC-00002

Esta mensagem de erro será gerada se a solicitação tiver mais de 20 Números de série.

O Código de linha de produto não pode ter mais de 40 caracteres. Verifique sua entrada e tente novamente.

UAN-GEN-00123

Esta mensagem de erro será gerada quando o comprimento do vlor de Código de linha de produto tiver mais de 40 caracteres.

O Código de linha de produto contém caracteres inválidos. Verifique sua entrada e tente novamente.

UAN-GEN-00119

Esta mensagem de erro será gerada quando qualquer código de linha de produto tiver o caractere '*'.

Foram encontrados números de série duplicados na solicitação com a combinação de número de série <<serial number>> e código de linha de produto <<line code>>.

UAN-LIC-00001

Esta mensagem de erro será gerada quando a combinação do Número de série e do Código de linha de produto for repetida na solicitação.

Problema do sistema que impede o processamento. Tente novamente mais tarde.

UAN-GEN-00122

Este erro será gerado para qualquer erro técnico.

4.6.1 Amostra de resposta de erro

{ "status": "Error", "transaction_id": "LIC50770000001444078583", "message": [ { "error_code": "UAN-GEN-00119", "error_message": "Serial Number is not in valid format. Please check your entry and try again" } ] }


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.

Serviç os da rede de distribuiç ã o digital (DDWS) GetLicense - … · 6 | Manual de referê...

Documents

Transcript of Serviç os da rede de distribuiç ã o digital (DDWS) GetLicense - … · 6 | Manual de referê...