Servicios web de distribució n digital (DDWS) GetLicense - Manual del servicio

Transcripción

1 Servicios web de distribució n digital (DDWS) GetLicense - Manual del servicio

2 CONTENIDO Historial de revisiones Introducción Descripción general Documentación complementaria Para empezar Descripción general del servicio GetLicense Limitaciones Ventajas Información de referencia del servicio GetLicense Esquema de solicitud Esquema de respuesta Esquema de error Mensaje de solicitud Mensaje de respuesta Mensajes de error Ejemplo de respuesta de error Historial de revisiones Versión Fecha Autor Comentarios SJ Se han actualizado las URL de la sección CC Cambios en la marca de revisión inicial de la versión 2. 2 Manual de referencia del servicio web

3 1 Introducción 1.1 Descripción general La plataforma de servicios web de distribución digital (DDWS) es una solución de automatización que permite a nuestros socios realizar pedidos directamente a Autodesk; este proceso requiere muy pocos pasos por parte de los socios y ninguno por parte de Autodesk. Esta nueva función de negocio permitirá realizar verdaderas transacciones de servicio web B2B entre los socios y Autodesk. Para que los socios disfruten de una implementación eficaz de la plataforma de servicios digitales de Autodesk, las filiales deberán familiarizarse con los servicios web de REST, OAuth y JSON. En un documento llamado Guía a la programación, se ofrece un ejemplo de aplicación cliente (escrita en lenguaje Ruby) que ayudará a los desarrolladores de las filiales a usar la API del servicio digital. 1.2 Documentación complementaria Guía para desarrolladores de socios de Autodesk: esta guía ayudará a los socios en su proceso de incorporación y acceso a los servicios de DDWS. La guía sirve también para presentar a los socios la plataforma de servicios digitales de Autodesk, con instrucciones paso a paso que les guiarán a través de las actividades iniciales necesarias para la integración. Documentación de la API de autenticación: este documento guía a los socios a través del proceso de generación de credenciales, firmas y tokens de acceso necesarios para utilizar las API del servicio. También contiene información para el desarrollo de la aplicación de integración de un socio. Proporciona información básica acerca de la integración del servicio web y muestra el desarrollo de una aplicación típica. 2 Para empezar Como parte del proceso de incorporación, los socios deberán estar asociados con un único número específico del cliente (CSN, del inglés Customer Specific Number) y su aplicación deberá estar registrada con Autodesk. Para obtener más información sobre el proceso de incorporación, consulte la Guía para desarrolladores de socios de Autodesk. 3 Descripción general del servicio GetLicense La finalidad de este servicio es recuperar la información de componentes de determinados números de serie o de una combinación de códigos de línea de productos y números de serie. 3 Manual de referencia del servicio web

4 Este servicio hace y proporciona lo siguiente: Obtiene la información de componentes en función de los números de serie especificados o de una combinación de códigos de línea de productos y números de serie. Capacidad para validar la información de licencia antes del envío del pedido. La implementación de una muestra de búsqueda de un único componente se muestra a continuación. Nota: Esta es una interfaz de usuario de ejemplo 4 Manual de referencia del servicio web

5 3.1 Limitaciones El servicio actual tiene el siguiente conjunto de limitaciones: 1. Búsqueda manual de componentes y licencias. 2. Imprecisión de transacciones. 3. Problemas de EDI y de integración empresarial. 4. Mayor tiempo de procesamiento de pedidos. 3.2 Ventajas El servicio de GetLicense ofrece las siguientes ventajas: 1. Un servicio web REST de poco tamaño que se puede consumir fácilmente desde cualquier aplicación mediante una conexión HTTP. 2. Flexibilidad para socios para obtener información de componentes con un número de serie específico o proporcionando la combinación de código de línea de productos y número de serie. 3. Los distribuidores pueden obtener información de los componentes para varios números de serie en una única solicitud. 4. Búsqueda automatizada de componentes y licencias. 5. Verificación a priori de la información del pedido. 6. Precisión de las transacciones. 7. Integración empresarial más rápida. 8. Acceso a la información directamente desde sistemas de ADSK. 9. Procesamiento de pedidos más rápido. 10. Consultas manuales automatizadas. 4 Información de referencia del servicio GetLicense 4.1 Esquema de solicitud Elemento Código de la línea de producto Número de serie Tipo de campo Cadena Cadena Longitud/formato de entrada Longitud: 40 carasscteres máx. Longitud: 12 caracteres máx. Utilización Opcional Obligatorio 5 Manual de referencia del servicio web

6 4.2 Esquema de respuesta La tabla siguiente muestra los campos de respuesta, según el tipo de socio. No distribuidor /no proveedor del registro Distribuidor Distribuidor GetLicenseResponse/Lice nce* GetLicenseResponse/Lice nce* GetLicenseResponse/Lice nce* 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 deployment deployment deployment description description description 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 seats seats seats serial_number serial_number serial_number status status status subscription_flag subscription_flag subscription_flag usage_type usage_type usage_type No aplica contact_ address contact_ address subscription_program_type subscription_program_type subscription_program_type No aplica contact_first_name contact_first_name No aplica contact_last_name contact_last_name recent_activation_date recent_activation_date recent_activation_date licensing_model licensing_model licensing_model No aplica contract_term contract_term No aplica account_address account_address 6 Manual de referencia del servicio web

7 relationship_from/relations hip relationship_from/relations hip group_name group_name group_name product_name product_name product_name seats seats seats serial_number serial_number serial_number status status status relationship_from/relations hip relationship_to/relationship relationship_to/relationship relationship_to/relationship group_name group_name group_name product_name product_name product_name seats seats seats serial_number serial_number serial_number status status status Si una de las instancias de serialnumber_productlinecode no existe, la matriz de mensajes tendrá un objeto JSON para indicar que no se ha encontrado un resultado. El objeto JSON tendrá los siguientes campos. No distribuidor /no proveedor del registro Distribuidor serial_number serial_number serial_number error_code error_code error_code error_message error_message error_message Distribuidor A continuación se describe lo que sucede cuando no se encuentra una entrada de serialnumber_productlinecode. Mensaje de error Código de error Descripción del error Número de serie no encontrado en los sistemas de Autodesk. SOA-License-006 Indica que no se han encontrado resultados para uno de los números de serie proporcionados. 4.3 Esquema de error Nombre de campo status message error_code error_message transaction_id Descripción Respuesta de confirmación: "Correcto", "Error" Mensaje de fallo o errores Código de error asociado con el mensaje de error Descripción de la respuesta de la causa del error ID único de transacción (combinación de LIC, número de serie y sello horario) 7 Manual de referencia del servicio web

8 4.4 Mensaje de solicitud A continuación se muestran solicitudes de ejemplo para la operación GetLicense. Los socios puede obtener información del componente para varios números de serie, para números de serie individuales y para combinaciones de números de serie y códigos de línea de productos tal como se especifica en las siguientes solicitudes de ejemplo. qa.autodesk.com/v2/license?serialnumber_productlinecode= , 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 qa.autodesk.com/v2/license?serialnumber_productlinecode= , Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>> OR CIV3D Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>> 8 Manual de referencia del servicio web

9 4.5 Mensaje de respuesta "status": "OK", "transaction_id": "LIC ", "message": [ "contract_number": " ", "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": " ", "deployment": "Standalone", "description": "AutoCAD Civil 3D 2007 English, International", "license_behavior": "Term Extendable", "license_type": "Upgrade", "part_number": " ", "product_key": "25554", "product_line": "Autodesk AutoCAD", "product_line_code": "CIV3D", "registered_date": "05/19/2007", "seats": "1", "serial_number": " ", "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": " ", "status": "Upgraded", ],, "relationship_to": "relationship": [ "product_name": "autodesk 3dxmax 2016 Non-Language Specific", "seats": "1", 9 Manual de referencia del servicio web

10 "serial_number": " ", "status": "Registered", ],, "contact_ address": "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 Mensajes de error La siguiente tabla muestra los códigos de error y sus respectivos mensajes de error presentes en los mensajes de respuesta, si existen errores: Mensaje de error Código de Descripción del error error Introduzca el número de serie Este mensaje de error se genera cuando el número de serie está vacío o es Número de serie no puede superar los 12 caracteres. Compruebe la entrada y vuelva a intentarlo. El número de serie contiene caracteres no válidos. Compruebe la entrada y vuelva a intentarlo nulo. Este mensaje de error se genera cuando la longitud del número de serie es superior a 12 caracteres. Este error se genera si Número de serie se envía con caracteres especiales que no son '-'. El número de serie no tiene un formato válido. Compruebe la entrada y vuelva a intentarlo. Ejemplo de número de serie no válido: 341- *%^@#$@#$ADGH Este error se genera si no el número de serie no tiene '-'. Ejemplo de número de serie no válido: Manual de referencia del servicio web

11 No puede haber más de 20 números de serie en la solicitud. El código de la línea de producto no puede superar los 40 caracteres. Compruebe la entrada y vuelva a intentarlo. El Código de la línea de producto incluye caracteres no válidos. Compruebe la entrada y vuelva a intentarlo. Se han encontrado números de serie duplicados en la solicitud con la combinación de número de serie <<número de serie>> y código de la línea de producto <<código de la línea de producto>>. Problema del sistema que impide el procesamiento. Inténtelo de nuevo más tarde. UAN-LIC UAN-LIC Este error se genera si la solicitud contiene más de 20 números de serie. Este mensaje de error se genera cuando la longitud del valor del Código de la línea de producto supera los 40 caracteres. Este mensaje de error se genera cuando un código de línea de producto contiene el carácter "*". Este mensaje de error se genera si la combinación del número de serie y el Código de la línea de producto se repite en la solicitud. Este error se generará a raíz de cualquier error técnico Ejemplo de respuesta de error "status": "Error", "transaction_id": "LIC ", "message": [ "error_code": "00119", "error_message": "Serial Number is not in valid format. Please check your entry and try again" ] Nota: Este Manual de referencia del servicio es para uso exclusivo de los destinatarios a los que se dirige y puede contener información propietaria o confidencial que puede ser información reservada o estar protegida frente a la divulgación. Queda totalmente prohibida cualquier revisión, uso, difusión o distribución no autorizados. 11 Manual de referencia del servicio web