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

Transcripción

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

2 CONTENIDO Historial de revisiones Introducción Descripción general Documentación complementaria Para empezar Descripción general del servicio GetMyPrice Detalles de GetMyPrice Ventajas del servicio GetMyPrice Información de referencia del servicio GetMyPrice Esquema de solicitud Esquema de respuesta Esquema de error Mensajes de solicitud Mensajes de respuesta Mensajes de error Códigos y mensajes de error Ejemplo de respuestas de error... 9 Historial de revisiones Versión Fecha Autor Comentarios /10/2015 AR Se ha agregado la sección de historial de revisiones /11/2015 AR En la versión en inglés, se ha corregido la columna Utilización para mostrar "Optional" en lugar de "Mptional" para el campo de cantidad en la sección /12/2015 AR Se han actualizado los mensajes de respuesta en la sección /03/2016 PL Se han actualizado los mensajes y los códigos de error de la sección 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 distribuidores realizar pedidos directamente a Autodesk mediante un proceso que requiere muy pocos pasos por parte de los distribuidores y ninguno por parte de Autodesk. Esta nueva función de negocio permitirá realizar verdaderas transacciones de servicio web B2B entre los distribuidores y Autodesk. Para que los distribuidores 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 de 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 distribuidores de Autodesk: esta guía ayudará a los distribuidores en su proceso de incorporación y acceso a los servicios de DDWS. La guía sirve también para presentar a los distribuidores 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 distribuidores 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 distribuidor. 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 distribuidores 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 distribuidores de Autodesk. 3 Manual de referencia del servicio web

4 3 Descripción general del servicio GetMyPrice 3.1 Detalles de GetMyPrice. La finalidad del servicio GetMyPrice consiste en permitir lo siguiente: 1. Proporcionar a Disti/DVAR su precio de compra. 2. Proporcionar un PVR a distribuidores no directos. 3. Durante la creación de pedidos (mediante PlaceOrder), proporcione el precio que paga el distribuidor en ese pedido concreto. a) Por ejemplo, si se añade a un contrato existente, el precio del pedido tendría que prorratearse. 3.2 Ventajas del servicio GetMyPrice 1. Un servicio web de REST optimizado que se puede consumir fácilmente desde cualquier aplicación a través de una conexión HTTP(s). 2. Proporciona los precios correctos por distribuidor y SKU. 3. Ayuda con la entrada y la validación de pedidos. 4. Mejora la calidad de los datos mediante la recuperación de información de precios en tiempo real. 4 Manual de referencia del servicio web

5 4 Información de referencia del servicio GetMyPrice 4.1 Esquema de solicitud El esquema de solicitud de GetMyPrice utiliza los campos siguientes como entradas. Los campos part_number, customer_number y price_date deben incluirse en una solicitud de un distribuidor, junto con una de las siguientes combinaciones de los campos restantes: 1) Ninguno 2) agreement_number 3) opportunity_number 4) quantity 5) agreement_number, quantity 6) opportunity_number, quantity Nombre del campo Tipo de campo Longitud y formato de entrada Utilización part_number STRING Long. máx. 17 Obligatorio customer_number INT longitud == 10 Obligatorio opportunity_number STRING N/D Opcional agreement_number INT longitud == 12 Opcional price_date DATE Formato: ISO 8601 AAAA-MM-DD Obligatorio quantity INT Long. máx. 13 Opcional 4.2 Esquema de respuesta Nombre del campo status_code status message response Descripción Código correspondiente al tipo de estado Respuesta de confirmación: "OK", "FAILED", "ERROR" Comparte el tipo de precio Precio 4.3 Esquema de error Nombre del campo Descripción status Respuesta de confirmación: OK, FAILED, ERROR status_code Código correspondiente al estado que se muestra. message Mensaje de fallo o errores message_code Código correspondiente al mensaje de error que se muestra error_message Especifica el motivo del error detectado response : Vacío debido al error detectado 5 Manual de referencia del servicio web

6 4.4 Mensajes de solicitud A continuación, se muestran ejemplos de solicitudes correspondientes a otras combinaciones 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 referencia del servicio web

7 4.5 Mensajes de respuesta A continuación, se muestran ejemplos de mensajes de respuesta correspondientes a los ejemplos de solicitudes 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 referencia del servicio web

8 4.6 Mensajes de error La siguiente tabla muestra ejemplos de códigos de error y sus mensajes de error respectivos presentes en los mensajes de respuesta en caso de encontrarse un error: Códigos y mensajes de error A continuación, se indican los códigos y los mensajes de error correspondientes a este servicio. Número de mensaje UAN-GEN UAN-GEN UAN-GEN UAN-GEN UAN-GEN UAN-GEN APG-DWS-INV-002 Mensaje de error El número de cliente es obligatorio. Número de cliente no válido. Compruebe la entrada y vuelva a intentarlo. Proporcione una combinación válida de parámetros. Introduzca los nombres de parámetros correctos. Introduzca el número de SKU. El número de pedido debe tener 10 caracteres exactamente. Compruebe la entrada y vuelva a intentarlo. El número de cliente proporcionado no es válido. Introduzca un valor válido de opportunity_number. 8 Manual de referencia del servicio web

9 4.6.2 Ejemplo de respuestas de error 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 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. 9 Manual de referencia del servicio web