Digital Distribution Web Services (DDWS) PlaceOrder: Manual del servicio

Transcripción

1 Digital Distribution Web Services (DDWS) PlaceOrder: Manual del servicio

2 CONTENIDO Historial de revisiones Introducción Descripción general Documentación de soporte Para empezar Descripción general del servicio PlaceOrder Suscripción a Autodesk Renovable Cumplimiento de pedidos Denegar pedidos Mensajes de SNS Obtener estado del pedido Información de referencia del servicio PlaceOrder Cumplimiento de pedidos Esquema de solicitud: crear pedido inicial Esquema de solicitud: añadir puestos Esquema de solicitud: añadir productos Esquema de solicitud: renovación Actualización de pedido de compra periódico Esquema de solicitud: actualización de pedido de compra periódico Obtener estado del pedido Esquema de solicitud: obtener estado del pedido (solo para pedidos iniciales periódicos) Revocación de pedidos Esquema de solicitud: eliminar puestos, eliminar productos, cancelar pedidos Esquema de solicitud: crear pedido inicial Esquema de respuesta: actualización de pedido de compra periódico Esquema de respuesta: obtener estado del pedido Esquema de respuesta: eliminar licencias, eliminar productos, cancelar pedidos (solo periódicos) Esquema de respuesta Notificación de SNS Ejemplos de mensajes Mensaje de solicitud: cumplimiento de pedidos, pedido inicial, modelo de suscripción periódica Mensaje de respuesta: cumplimiento de pedidos, pedido inicial Mensaje de respuesta: cumplimiento de pedidos, pedido inicial, modelo de suscripción renovable Mensaje de respuesta: cumplimiento de pedidos, pedido inicial Manual de referencia del servicio web

3 5.3 Mensaje de solicitud: cumplimiento de pedidos, adición de puestos, modelo de suscripción periódica Mensaje de respuesta: cumplimiento de pedidos, adición de puestos, modelo de suscripción periódica Mensaje de solicitud: cumplimiento de pedidos, adición de puestos, modelo de suscripción renovable Mensaje de respuesta: cumplimiento de pedidos, adición de puestos, modelo de suscripción renovable Mensaje de solicitud: cumplimiento de pedidos, adición de productos, modelo de suscripción periódica Mensaje de respuesta: cumplimiento de pedidos, adición de productos, modelo de suscripción periódica Mensaje de solicitud: cumplimiento de pedidos, adición de productos, modelo de suscripción renovable Mensaje de respuesta: cumplimiento de pedidos, adición de productos, modelo de suscripción renovable Mensaje de solicitud: cumplimiento de pedidos, renovación, solo modelo de suscripción renovable Mensaje de respuesta: cumplimiento de pedidos, renovación, solo modelo de suscripción renovable Mensaje de solicitud: actualización de pedido de compra periódico Mensaje de respuesta: actualización de pedido de compra periódico Mensaje de solicitud: obtener estado del pedido Mensaje de respuesta: obtener estado del pedido Mensaje de solicitud: revocación de pedidos (eliminación de puestos, eliminación de productos, cancelación de pedidos) Mensaje de respuesta: denegar pedidos (eliminar licencia, eliminar producto, cancelación de pedidos) Mensaje de solicitud: denegar pedidos (devolución de pedidos) Mensaje de respuesta: denegar pedidos (devolución de pedidos) Mensaje de solicitud: mensajes de SNS Mensaje de respuesta: mensajes de SNS Normas de formato Mensajes de error Códigos de error Mensaje de error Manual de referencia del servicio web

4 Historial de revisiones Versión Fecha Autor Comentarios /10/2015 AR Se agregaron las secciones 4.2, 4.7, 5.2 y para incluir el servicio de facturación periódica /10/2015 AR Se ha actualizado el servicio anteriormente denominado Facturación periódica a Actualización de pedido de compra periódico y URL de solicitud /10/2015 AR Se modificaron los valores de action_name relativos al cumplimiento del pedido de "add_seat" y "add_product" a "add_seats" y "add_products» /11/2015 AR Se modificó el mensaje de solicitud de muestras para el cumplimiento de los pedidos, pedido inicial en la sección 5.1 para mostrar una carga de muestra de los modelos de suscripción periódica. Se modificó el mensaje de solicitud de muestras para el cumplimiento de los pedidos, pedido inicial en la sección 5.2 para mostrar una carga de muestra de los modelos de suscripción renovable. Se modificó el esquema de solicitud de creación de pedido inicial. 4 Manual de referencia del servicio web

5 3.2 05/11/2015 AR Se ha agregado el esquema de solicitud add_seats en la sección 4.3 Se ha agregado el esquema de solicitud add_products en la sección 4.4 Se ha agregado el esquema de solicitud renew en la sección 4.5 Se ha modificado el esquema de solicitud initial_order en la sección 4.2 Se han agregado las secciones 5.3, 5.4, 5.5, 5.6 y 5.7, que incluyen mensajes de muestra de las acciones de cumplimiento de pedidos: add_seats, add_products y renew /11/2015 AR Se han actualizado los datos de muestra de los mensajes de muestra de la sección 5. Se ha actualizado el esquema de solicitud Renew de la sección 4.5 para eliminar subscription_id. Se ha actualizado el esquema de solicitud initial_order de la sección 4.2 para eliminar external_ref_ number. 5 Manual de referencia del servicio web

6 3.4 09/11/2015 AR Se han modificado los ejemplos de fechas de esquema de solicitud para adaptarse al formato ISO Se han actualizado los valores posibles de "action_name" para Denegar pedidos para eliminar productos, eliminar puestos, cancelar y devolver. Nota: La devolución no está disponible actualmente. Se ha actualizado el esquema de solicitud de revocación de pedidos en la sección Se han añadido descripciones para los modelos de suscripción en la sección 3.1. Se ha añadido "related_account_cs n" al esquema de solicitud de adición de puestos en la sección 4.3. Se ha eliminado "pricing_date" del esquema de solicitud de adición de puestos en la sección 4.3. Se han modificado los códigos de error en la sección /12/2015 AR Se han modificado las secciones para reflejar los esquemas de 6 Manual de referencia del servicio web

7 solicitudes más recientes. Se ha modificado la sección 4.9 de "po_number" a "número de referencia" /02/2016 RL Se han convertido todos los campos denominados "quantity" a entero /02/2016 RL Se ha sustituido el campo ref_document por los campos opportunity_type y opportunity_number /02/2016 RL Se ha eliminado el campo order_date. Se indican las reglas de contract_start_date /02/2016 CC Se ha actualizado la documentación del esquema de respuesta de la API de estado /02/2016 CC Se ha actualizado SNS para indicar la disponibilidad de todos los servicios de realización de pedidos /03/16 PL Sección 4.2: se han eliminado los comentarios de first_name, last_name, , eu_first_name, eu_last_name y eu_ . Sección 4.2: se ha cambiado de O a R para first_name, last_name, , eu_first_name, 7 Manual de referencia del servicio web

8 eu_last_name y eu_ . Sección 4.2: se ha editado la sección de comentarios a solo "Proporciónelo si dispone del dato" para contact_csn, eu_contact_csn. Sección 4.2: en la sección de comentarios de todos los campos que comienza por primary_account, related_account, eu_primary_account se ha añadido "*Las reglas se aplican solo a pedidos periódicos" /03/16 PL Secciones 4.2, 4.3, 4.4 y 4.11: se han actualizado todos los campos de cantidad, que deben ser un entero positivo. Secciones 4.2, 4.3 y 4.4: se ha actualizado la longitud máxima a 80 caracteres para los campos de correo electrónico y eu_ . Secciones 4.2, 4.4 y 5.1: se ha añadido Address_Line2 y Address_Line3 para los campos primary, eu_primary y related_account /05/16 PL Se han eliminados los siguientes campos de las secciones 4.2, 4.3, 8 Manual de referencia del servicio web

9 4.4 y 4.5, así como sus correspondientes mensajes de respuesta: item_end_date, contact_csn, eu_csn, contract_end_date, currency_code, eu_contact_csn. Se han añadido descripciones de campos para todos los campos de las secciones 4.2, 4.3, 4.4 y 4.5. Se ha añadido un posible mensaje de error a la sección /07/2016 FX Se han eliminado todas las instancias de Desktop Subscription, ya que esta terminología está obsoleta. Se ha denominado período a la duración de una suscripción. En la versión en inglés, "multiyear" se ha cambiado a "multi-year" ("de varios años") y ahora se utiliza como término genérico. 9 Manual de referencia del servicio web

10 1 Introducción 1.1 Descripción general Digital Distribution Web Services (DDWS) incluye una solución de automatización que permite a nuestros distribuidores realizar pedidos directamente a Autodesk; este proceso requiere muy pocos pasos por parte de los distribuidores y ninguno por parte de Autodesk. La nueva función de negocio permitirá realizar verdaderas transacciones de servicio web B2B entre los distribuidores y Autodesk. El envío del pedido estaría totalmente automatizado desde el distribuidor a Autodesk y de vuelta al cliente final sin necesidad de ningún contacto manual. Para que el distribuidor disfrute de una implementación eficaz de la DDWS de Autodesk, las filiales deberán familiarizarse con los servicios web de REST, OAuth 2.0 y JSON. En el documento Guía de programación se incluye un ejemplo de aplicación cliente en lenguaje Ruby. Dicho ejemplo ayudará a los desarrolladores de las filiales a utilizar la API de DDWS. 1.2 Documentación de soporte 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. Detalles del esquema y la interfaz de la API: este documento contiene información de carga acerca de todos los posibles escenarios de realización de pedidos. Los desarrolladores la pueden utilizar para generar ejemplos de solicitudes rellenando los campos deseados. Consulte el portal de desarrolladores para obtener más información sobre Autodesk Web Services. En el portal, puede encontrar toda la documentación disponible e instrucciones paso a paso sobre cómo funcionan nuestros servicios. 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). El distribuidor deberá tener la aplicación correspondiente 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. 10 Manual de referencia del servicio web

11 3 Descripción general del servicio PlaceOrder El servicio PlaceOrder expone dos recursos de la API para gestionar los pedidos: /orders/fulfillment y /orders/revoke. Estos recursos están formados por operaciones, que gestionan la creación de pedidos, la cancelación de pedidos, la devolución de pedidos, la adición de puestos y productos a contratos existentes, así como la eliminación de puestos y productos de contratos existentes. En este documento se incluyen los distintos escenarios del servicio PlaceOrder que están disponibles para la generación de pedidos o la aplicación de modificaciones al contrato en el entorno de Autodesk. Los detalles de los servicios incluidos en el proceso de cumplimentar pedidos y denegar pedidos aparecen a continuación. Envío de nuevos pedidos Adición de puestos a contratos existentes Adición de productos a contratos existentes Eliminar licencias de contratos existentes Eliminar productos de contratos existentes Devolver un contrato periódico (actualmente no disponible) Cancelación de un contrato de periodicidad 11 Manual de referencia del servicio web

12 3.1 Suscripción a Autodesk La suscripción a Autodesk es un enfoque de pago por uso que ofrece a los clientes la opción de seleccionar un período de suscripción mensual, trimestral, anual o de varios años. Existen dos modelos principales: el periódico y el renovable En un modelo de suscripción periódica, la suscripción determinada por el cliente se actualiza de forma automática según el período que el distribuidor haya seleccionado (mensual, trimestral o anual). La suscripción continúa indefinidamente y solo se cancela cuando el cliente lo solicita de forma explícita, o bien cuando cambia el modelo de la suscripción en cuestión Renovable Cuando los clientes se suscriben a un servicio con el modelo renovable, la suscripción caducará una vez que finalice el período seleccionado (trimestral, anual o de varios años). Esta suscripción se puede renovar antes del final del período. En resumen, una suscripción renovable tiene una fecha de finalización asociada a la suscripción, mientras que la suscripción periódica no la tiene. 3.2 Cumplimiento de pedidos El recurso API Cumplimiento de pedidos gestiona creación de pedidos, añadir licencias y añadir operaciones del producto. Las operaciones para añadir licencias y añadir operaciones del producto son solo para los contratos existentes. 3.3 Denegar pedidos El recurso API Denegar pedidos gestiona la operación de devolución de pedidos para pedidos periódicos, así como eliminar licencias, eliminar productos y operaciones de cancelación. Las devoluciones solo son válidas dentro del periodo de gracia acordado. Si la devolución es válida, el contrato se cancelará y se reembolsará el importe. Para la operación de cancelación, finaliza el comportamiento de renovación automática. El contrato sigue siendo válido durante el resto del periodo. Las operaciones de eliminación de puestos y de eliminación de productos son solo para contratos existentes. 3.4 Mensajes de SNS Los mensajes de SNS son un servicio opcional en el que pueden participar los distribuidores de Autodesk y que les permite recibir alertas sobre cualquier servicio de realización de pedidos. El distribuidor recibirá un aviso cuando se haya completado la transacción del pedido. El mensaje de la alerta indica el estado de la transacción. Se indicará si el estado de la transacción es "Correcto" o "Error". Los mensajes de SNS están disponible para todos los escenarios de realización de pedidos para el modelo periódico y el de renovación. Si se ha suscrito para recibir notificaciones de cumplimiento de pedidos, el distribuidor puede elegir uno de los tres métodos de entrega siguientes: o Correo electrónico o Mensaje SMS o Punto final 12 Manual de referencia del servicio web

13 3.5 Obtener estado del pedido El recurso de la API de Obtener estado del pedido devuelve el estado actual de un determinado pedido después de proporcionar el número de referencia obtenido en la respuesta de la API de Realizar pedido. La API de Obtener estado del pedido es compatible con todos los servicios de realización de pedido para el escenario periódico y el de renovación. Para recuperar el estado del pedido de compra deseado, deberá proporcionarse el ID de transacción del pedido. 4 Información de referencia del servicio PlaceOrder Nota: La siguiente sección contiene el esquema de solicitud y respuesta para el servicio PlaceOrder. El uso que hace el distribuidor de uno de los dos modelos de suscripción (el renovable o el periódico) determina cuáles son los campos obligatorios u opcionales de cada uno de los siguientes esquemas. En este punto, los distribuidores pueden no enviar pedidos en una combinación de modelos de suscripción periódicos y renovables. De este modo, se devolverá una respuesta de error. 4.1 Cumplimiento de pedidos Según el campo action_name proporcionado en el texto de la solicitud, se invocarán diferentes operaciones. Por ejemplo, si action_name tiene el valor "initial_order", se especificará la opción de crear un pedido, mientras que si tiene el valor "add_seats", se indicará la opción de añadir licencias. A continuación se muestra el esquema de solicitud para los casos en los que el tipo de solicitud es para la creación de pedidos o para añadir licencias o productos. El esquema de respuesta asociado se incluye también. Los valores posibles de action_name son los siguientes: initial_order, add_seats y add_products. 4.2 Esquema de solicitud: crear pedido inicial Los detalles de los campos esperados en el cuerpo de la solicitud se encuentran en la tabla siguiente para creación de pedidos. Se requieren campos relacionados con el usuario final, el cliente y la información del producto. Las filas resaltadas son elementos cuyo valor es un objeto JSON o una Matriz que contiene la información de las filas con sangría debajo. Consulte la sección de mensajes de solicitud de ejemplo para la correcta anidación de campos. Si una cuenta existe y se proporciona el CSN correspondiente, los datos del cliente se pueden recuperar de sistemas de Autodesk. Si no se incluye CSN, los distribuidores deben proporcionar información como el nombre, la dirección y la ubicación para poder crear una cuenta nueva. Nota acerca del cumplimiento de pedidos: Cuando los sistemas de Autodesk reciben el pedido inicial de un distribuidor, se realizan a priori validaciones básicas de elementos tales como la SKU, el contrato y el precio en la capa de servicios del servicio de la API PlaceOrder. Después de esto, se genera una respuesta que se envía al distribuidor relacionada con la ejecución correcta o incorrecta de la solicitud con un número de referencia (que consta de una concatenación del CSN, el número de pedido de compra y la marca de tiempo). El distribuidor puede comprobar el estado del pedido de compra introduciendo el número de referencia en la API GetOrderStatus. Por último, los sistemas de Autodesk actualizan el estado de la transacción de un estado de procesamiento a un estado completado cuando el pedido en cuestión se crea en SAP. 13 Manual de referencia del servicio web

14 Pedido Datos de contrato Matriz de campo Definición del esquema Descripción del campo Ejemplo action_name opportunity_type opportunity_number po_date po_number customer_po_number Nombre del evento que va a realizar el distribuidor al realizar el pedido Tipo de oportunidad de venta exclusivo creado para un pedido ID exclusivo que hace referencia a una oportunidad de ventas que se ha creado para un pedido Fecha en la que el distribuidor genera un pedido de compra en su sistema interno (puede ser la fecha del sistema o una fecha en el pasado) Número de pedido de compra especificado por el solicitante para identificar cada pedido Número de pedido de compra del cliente. Tipo de campo Máx. Caract. Requerido/ opcional (R/O) Comentarios Renovación/ periódico "initial_order" Cadena 13 R initial_order "A" Cadena 1 O "A " Cadena 15 O contract_start_date Fecha de inicio del contrato Formato de fecha ISO 8601 Los valores posibles son "A" (ACE) y "R" (Renovación). Al proporcionar una instancia de opportunity_type o de opportunity_number, también debe proporcionar la otra. 10 O ORD1234 Cadena 35 R " " Cadena 35 O Formato de fecha ISO O Cuando se especifica el valor de contract_start_date, la fecha debe estar en un intervalo entre la fecha actual y 30 días después de la fecha actual. Cuando no se especifica el valor de contract_start_date, la fecha es la fecha actual. 14 Manual de referencia del servicio web

15 EndUserContact end_user first_name last_name language primary_account_csn Nombre del responsable del contrato (persona de contacto) Apellido del responsable del contrato (persona de contacto) Correo electrónico del responsable del contrato (persona de contacto) Preferencia de idioma de la persona de contacto CSN de cuenta del usuario final Matriz de objeto JSON R "John" Cadena 35 R "Smith" Cadena 35 R joh.smith@sttest.com Cadena 80 R "ES" Cadena 2 O Cadena 10 O primary_account_name Nombre de la cuenta Partner Inc1 Cadena 35 O primary_account_address_li ne1 primary_account_address_li ne2 primary_account_address_li ne3 Línea 1 de la dirección de la cuenta Línea 2 de la dirección de la cuenta Línea 3 de la dirección de la cuenta 1 Parkway Road Cadena 35 O "Dept. ingeniería" Cadena 35 O "Desk 5405" Cadena 35 O Correo electrónico estándar Si no se especifica, el idioma por defecto será el inglés Proporciónelo si dispone del dato; de lo contrario, rellene los detalles de la cuenta principal a continuación. proporciona el primary_account_csn proporciona el primary_account_csn proporciona el primary_account_csn proporciona el primary_account_csn 15 Manual de referencia del servicio web

16 primary_account_address_ci ty 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 Ciudad de la cuenta "San José" Cadena 35 O Estado de la cuenta "CA" Cadena 35 O El código de país de la cuenta "US" Cadena 35 O Código postal de la cuenta Cadena 35 O CSN de la cuenta a la que está asociado el responsable del contrato (podría ser igual o diferente) Nombre de la cuenta a la que está asociado el responsable del contrato Línea 1 de la dirección de la cuenta relacionada Cadena 10 O Partner Inc Cadena 35 O 1 Parkway Road Cadena 35 O proporciona el primary_account_csn proporciona el primary_account_csn proporciona primary_account_csn. Código ISO de 2 dígitos proporciona el primary_account_csn Proporciónelo si dispone del dato; de lo contrario, rellene los detalles de la cuenta relacionada a continuación. proporciona el related_account_csn proporciona el related_account_csn 16 Manual de referencia del servicio web

17 related_account_address_lin e2 related_account_address_lin e3 related_account_address_cit y related_account_address_st ate related_account_address_c ountry_code related_account_address_p ostal_code Línea 2 de la dirección de la cuenta relacionada Línea 3 de la dirección de la cuenta relacionada Ciudad de la cuenta relacionada Estado de la cuenta relacionada Código de país de la cuenta relacionada Código postal de la cuenta relacionada "Dept. ingeniería" Cadena 35 O "Desk 5405" Cadena 35 O "San José" Cadena 35 O "CA" Cadena 35 O "US" Cadena 35 O Cadena 35 O proporciona el related_account_csn proporciona el related_account_csn proporciona el related_account_csn proporciona el related_account_csn proporciona el related_account_csn. Código ISO de 2 dígitos proporciona el related_account_csn Reseller Party SoldToPar ty reseller_account_csn sold_to_account_csn other_parties CSN de la cuenta relacionada CSN de la cuenta del comprador Cadena 10 R Distribuidor DL Cadena 10 O Matriz de objeto JSON R CSN del distribuidor al que se ha vendido Si no se facilita, se tomará el valor del encabezado de la autorización. Renovación 17 Manual de referencia del servicio web

18 ListOfLineItems account_csn partner_type line_items subscription_id CSN de la cuenta de terceros (p. ej., agencia de transportes) El valor que se puede introducir solo es "ForwardingAgent" En el caso de pedidos periódicos, para poder identificar de forma exclusiva cada línea de productos, se deberá generar un único ID de suscripción por línea de productos. Deberá hacerse referencia al mismo ID de suscripción al realizar transacciones posteriores, como añadir puestos para la misma línea de productos del mismo contrato " " Cadena 10 R Renovación "ForwardingAgent" Cadena 18 R Renovación "845cd4b7-2f20-4c1a-aaa " Matriz de objeto JSON part_number SKU 001G1-WW7929-T210 Cadena 35 R quantity Cantidad 1 R Cadena 36 R Formato UUID Versión 4. Entero positivo R SKUNumber -> part_number net_amount Importe "39.33" Cadena 20 R delivery_method eu_first_name eu_last_name eu_ El valor de método de entrega que se va a pasar "ED" Nombre del responsable de software (persona de contacto) Apellido del responsable de software (persona de contacto) Correo electrónico del responsable de software (persona de contacto) "ED" Cadena - R Renovación "Peter" Cadena 40 R "longslide" Cadena 40 R Peter.longslide@sttest.com Cadena 80 R Estándar: correo electrónico 18 Manual de referencia del servicio web

19 eu_language eu_country 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 Preferencia de idioma del responsable de software para comunicaciones Código de país del responsable de software CSN de cuenta a la que está asociado el responsable de software; en este caso, cuando el responsable de software de una línea de productos determinada es diferente al responsable del contrato Nombre de la cuenta a la que está asociado el responsable de software. Línea 1 de la dirección de la cuenta del responsable de software Línea 2 de la dirección de la cuenta del responsable de software Línea 3 de la dirección de la cuenta del responsable de software Ciudad de la cuenta del responsable de software "EN" Cadena 2 R Código ISO de 2 dígitos "US" Cadena 2 R Código ISO de 2 dígitos Cadena 10 O Partner Inc1 Cadena 35 O 1 Parkway Road Cadena 35 O "Dept. ingeniería" Cadena 35 O "Desk 5405" Cadena 35 O "San José" Cadena 35 O Proporciónelo si dispone del dato; de lo contrario, rellene los detalles de eu_primary_account a continuación. proporciona eu_primary_account_csn proporciona eu_primary_account_csn proporciona eu_primary_account_csn proporciona eu_primary_account_csn proporciona eu_primary_account_csn 19 Manual de referencia del servicio web

20 eu_primary_account_addres s_state Estado de la cuenta del responsable de software "CA" Cadena 35 O proporciona eu_primary_account_csn eu_primary_account_addres s_country_code Código de país de la cuenta del responsable de software "US" Cadena 35 O proporciona eu_primary_account_csn. Código ISO de 2 dígitos eu_primary_account_addres s_postal_code Código postal de la cuenta del responsable de software Cadena 35 O proporciona eu_primary_account_csn 20 Manual de referencia del servicio web

21 Ahora la carga útil puede ser de dos tipos. Si se conocen el CSN de la cuenta principal, el CSN de la cuenta relacionada o el valor de eu_primary_account_csn, puede crear la carga útil tal como se muestra en la siguiente versión mejorada. Carga útil del pedido inicial existente Carga útil del pedido inicial mejorado 21 Manual de referencia del servicio web

22 4.3 Esquema de solicitud: añadir puestos Matriz de campo Definición del esquema Descripción del campo Ejemplo action_name Nombre del evento que va a realizar el distribuidor al realizar el pedido, como añadir puestos. Tipo de campo Máx. car. Obligatorio u opcional (R/O) Comentarios 22 Manual de referencia del servicio web Renovación/ periódico "add_seats" Cadena 9 R "add_seats" contract_number Contrato o número de contrato " " Cadena 12 R po_date po_number customer_po_number Fecha en la que el distribuidor genera un pedido de compra en su sistema interno (puede ser la fecha del sistema o una fecha en el pasado) Número de pedido de compra especificado por el solicitante para identificar cada pedido Número de pedido de compra del cliente. contract_start_date Fecha de inicio del contrato " " Fecha 10 O " " Cadena 35 R " " Cadena 35 O Formato de fecha ISO O Cuando se especifica el valor de contract_start_ date, la fecha debe estar en un intervalo entre la fecha actual y 30 días después de la fecha actual. Cuando no se especifica el valor de contract_start_ date, la fecha es la fecha actual. Renovación

23 line_items net_amount reseller_account_csn Importe total (suma de la cantidad de elementos de línea) CSN de la cuenta del distribuidor "105.32" Cadena 20 R Suma de todos los line_items " " Cadena 10 R Renovación sold_to_account_csn CSN de la cuenta del comprador Cadena 10 O opportunity_type opportunity_number line_items subscription_id item_start_date Tipo de oportunidad de venta exclusivo creado para un pedido ID exclusivo que hace referencia a una oportunidad de ventas que se ha creado para un pedido En el caso de pedidos periódicos, para poder identificar de forma exclusiva cada línea de productos, se deberá generar un único ID de suscripción por línea de productos. Deberá hacerse referencia al mismo ID de suscripción al realizar transacciones posteriores, como añadir puestos para la misma línea de productos del mismo contrato Fecha de inicio de la facturación de este puesto adicional "A" Cadena 1 O "A " Cadena 15 O "914fadc9-2b67-476e-b480- e0e232e98745" Matriz de objetos JSON R Cadena 36 R Si no se facilita, se tomará el valor del encabezado de la autorización. Los valores posibles son "A" (ACE) y "R" (Renovación). Al proporcionar una instancia de opportunity_typ e o de opportunity_nu mber, también debe proporcionar la otra. Cadena con formato UUID versión 4 Renovación " " Fecha 10 O Renovación 23 Manual de referencia del servicio web

24 part_number SKU "321K T979" Cadena 35 R quantity Cantidad 7 eu_ eu_first_name eu_last_name Correo electrónico del responsable de software (persona de contacto) Nombre del responsable de software (persona de contacto) Apellido del responsable de software (persona de contacto) Entero positivo R "admin@autodesk.com" Cadena 80 R Renovación "John" Cadena 40 R Renovación "Smith" Cadena 40 R Renovación net_amount Importe "105.32" Cadena 20 R serial_numbers Número de serie [" "] Matriz de cadenas R Importe neto por line_item Renovación 4.4 Esquema de solicitud: añadir productos Matriz de campo Definición del esquema Descripción del campo Ejemplo Tipo de campo Máx. car. Obligatorio u opcional (O) Comentarios Renovación/ periódico action_name Nombre del evento que va a realizar el distribuidor, como "add_products" Cadena 12 R "add_products" añadir productos contract_number Contrato o número de contrato " " Cadena 12 R po_number Número de pedido de compra especificado por el solicitante " " Cadena 35 R net_amount para identificar cada pedido Importe total (suma de la cantidad de elementos de línea) "105.32" Cadena 20 R Suma de todos los line_items 24 Manual de referencia del servicio web

25 po_date customer_po_number Fecha en la que el distribuidor genera un pedido de compra en su sistema interno (puede ser la fecha del sistema o una fecha en el pasado) Número de pedido de compra del cliente contract_start_date Fecha de inicio del contrato " " reseller_account_csn sold_to_account_csn opportunity_type opportunity_number CSN de la cuenta del distribuidor CSN de la cuenta del comprador Tipo de oportunidad de venta exclusivo creado para un pedido ID exclusivo que hace referencia a una oportunidad de ventas que se ha creado para un pedido " " Fecha 10 O Utiliza la fecha del sistema como valor predeterminado " " Cadena 35 O Formato de fecha ISO O Cuando se especifica el valor de contract_start_date, la fecha debe estar en un intervalo entre la fecha actual y 30 días después de la fecha actual. Cuando no se especifica el valor de contract_start_date, la fecha es la fecha actual. Renovación Cadena 10 R Renovación Cadena 10 O "A" Cadena 1 O "A " Cadena 15 O Si no se facilita, se tomará el valor del encabezado de la autorización. Los valores posibles son "A" (ACE) y "R" (Renovación). Al proporcionar una instancia de opportunity_type o de opportunity_ number, también debe proporcionar la otra. Renovación 25 Manual de referencia del servicio web

26 line_items line_items subscription_id En el caso de pedidos periódicos, para poder identificar de forma exclusiva cada línea de productos, se deberá generar un único ID de suscripción por línea de productos. Deberá hacerse referencia al mismo ID de suscripción al realizar transacciones posteriores, como añadir puestos para la misma línea de productos del mismo contrato "914fadc9-2b67-476e-b480- e0e232e98745" Matriz de objetos JSON R Cadena 36 R Cadena con formato UUID versión 4 part_number SKU "321K T868" Cadena 35 R quantity Cantidad 7 item_start_date eu_ eu_first_name eu_last_name end_user first_name last_name Fecha de inicio de la facturación de este puesto adicional Correo electrónico del responsable de software (persona de contacto) Nombre del responsable de software (persona de contacto) Apellido del responsable de software (persona de contacto) Nombre del responsable del contrato (persona de contacto) Apellido del responsable del contrato (persona de contacto) Correo electrónico del responsable del contrato (persona de contacto) Entero positivo R " " Fecha 10 O Renovación "admin@autodesk.com" Cadena 80 R Renovación "John" Cadena 40 R Renovación "Smith" Cadena 40 R Renovación Objeto JSON O "John" Cadena 35 R "Smith" Cadena 35 R john@autodesk.com Cadena 80 R 26 Manual de referencia del servicio web

27 language primary_account_csn Preferencia de idioma de la persona de contacto CSN de cuenta del usuario final "ES" Cadena 2 O " " Cadena 10 O primary_account_name Nombre de la cuenta "Arthur Doe" Cadena 35 O primary_account_address_line1 primary_account_address_line2 primary_account_address_line3 Línea 1 de la dirección de la cuenta Línea 2 de la dirección de la cuenta Línea 3 de la dirección de la cuenta 1 Parkway Road Cadena 35 O "Dept. ingeniería" Cadena 35 O "Desk 5405" Cadena 35 O primary_account_address_city Ciudad de la cuenta "San José" Cadena 35 O primary_account_address_state Estado de la cuenta "CA" Cadena 3 O primary_account_address_countr y_code El código de país de la cuenta "US" Cadena 3 O Si no se especifica, el idioma por defecto será el inglés Proporciónelo si dispone del dato; de lo contrario, rellene los detalles de la cuenta principal a continuación. proporciona el primary_account_c sn proporciona el primary_account_c sn proporciona el primary_account_c sn proporciona el primary_account_c sn proporciona el primary_account_c sn proporciona el primary_account_c sn proporciona primary_account_c sn. Código ISO de 2 dígitos 27 Manual de referencia del servicio web

28 primary_account_address_postal _code Código postal de la cuenta Cadena 9 O net amount Importe "105.32" Cadena 20 R proporciona el primary_account_c sn Importe neto por line_item 4.5 Esquema de solicitud: renovación Matriz de campo Definición del esquema Descripción del campo Ejemplo Tipo de campo Máx. car. Obligatorio u opcional (O) Comentarios Renovación/ periódico action_name Nombre del evento que va a realizar el distribuidor al realizar el pedido, "renew" Cadena 5 R "renew" Renovación como renovar. order_date Fecha en la que se realiza el pedido " " Fecha 10 O Renovación po_date Fecha en la que el distribuidor genera un pedido de compra en su sistema interno (puede ser la fecha " " Fecha 10 O Renovación del sistema o una fecha en el pasado) po_number Número de pedido de compra especificado por el solicitante para " " Cadena 35 R Renovación identificar cada pedido customer_po_number Número de pedido de compra del cliente. " " Cadena 35 O Renovación contract_number Contrato o número de contrato " " Cadena 12 R Renovación reseller_account_csn CSN de la cuenta del distribuidor Cadena 10 R Renovación sold_to_account_csn CSN de la cuenta del comprador Cadena 10 O Si no se facilita, se tomará el valor del encabezado de la autorización. Renovación 28 Manual de referencia del servicio web

29 line_items opportunity_type opportunity_number line_items Tipo de oportunidad de venta exclusivo creado para un pedido ID exclusivo que hace referencia a una oportunidad de ventas que se ha creado para un pedido "A" Cadena 1 O "A " Cadena 15 O Matriz de objetos JSON R Los valores posibles son "A" (ACE) y "R" (Renovación). Al proporcionar una instancia de opportunity_type o de opportunity_ number, también debe proporcionar la otra. Renovación Renovación Renovación part_number SKU "123K T979" Cadena 35 R Renovación quantity Cantidad 7 Entero positivo R Renovación net_amount Importe "105.32" Cadena 20 R serial_numbers Número de serie [" "] Matriz de cadenas R Importe neto por line_item Renovación Renovación 29 Manual de referencia del servicio web

30 4.6 Actualización de pedido de compra periódico El recurso de la API de Actualización de pedido de compra periódico realiza la actualización de un número de pedido de compra de manera que tenga facturación periódica. La API de Actualización de pedido de compra periódico solo se puede utilizar en el caso de distribuidores que se han suscrito con el modelo periódico. Esta suscripción se renovará de forma automática al final del período seleccionado (trimestral, anual o de varios años) y el pedido abierto existente se actualizará con un nuevo número de pedido de compra y la facturación periódica correspondiente. Con el fin de aplicar las actualizaciones, debe enviarse la solicitud al menos 48 horas antes de la facturación periódica prevista. 4.7 Esquema de solicitud: actualización de pedido de compra periódico Nota: El siguiente esquema solo se aplica a los distribuidores que utilicen un modelo de suscripción periódica. Descripción de campo Definición de esquema Ejemplo Tipo de campo Longitud Comentarios action_name "po_update" Cadena 9 Siempre debe ser "po_update" contract_number Cadena 30 Obligatorio po_number Cadena 35 Obligatorio 4.8 Obtener estado del pedido El microservicio Obtener estado del pedido es una solicitud GET sencilla con el siguiente formato: el cual solo tiene un campo en el esquema de solicitud, como se describe a continuación. También incluye el esquema de respuesta asociado, el cual consiste en un estado de éxito o error. 4.9 Esquema de solicitud: obtener estado del pedido (solo para pedidos iniciales periódicos) Descripción de campo Dirección URL Definición de esquema reference number Ejemplo /order/status/ Tipo de campo Cadena Longitud Mín. 20 Máx. 40 caracteres Comentarios Obligatorio. Parte de la dirección URL 4.10 Revocación de pedidos A continuación, se presenta el esquema de solicitud para los casos en los que el tipo de solicitud corresponde a la eliminación de puestos, la eliminación de productos, la cancelación de pedidos o la devolución de pedidos. También se incluye el esquema de respuesta asociado. Las solicitudes de revocación de pedidos solo están disponibles para los distribuidores que utilizan un modelo de suscripción periódica. Actualmente, las devoluciones de pedidos no están disponibles, pero formarán parte de una mejora posterior. Los valores esperados de action_name son los que se indican a continuación: eliminar puestos, eliminar productos, cancelar. 30 Manual de referencia del servicio web

31 4.11 Esquema de solicitud: eliminar puestos, eliminar productos, cancelar pedidos Los detalles de los campos esperados en el cuerpo de la solicitud para modificaciones a un pedido existente, como, por ejemplo, reducir la cantidad de puestos para eliminar otro producto, se encuentran en la siguiente tabla. Nota: El siguiente esquema solo se aplica a los distribuidores que utilicen un modelo de suscripción periódica. En este momento no hay disponible un esquema para el modelo de suscripción renovable. Descripción de campo Encabezado de contrato Nivel de elemento de línea Definición de esquema action_name Ejemplo "eliminar puestos" Tipo de campo Requerido/ Opcional Longitud Cadena R 15 Comentarios eliminar puestos, eliminar productos, cancelar contract_number Cadena R 30 Obligatorio Matriz de No se necesita line_items objetos R para la cancelación JSON subscription_id "bac19ced- 7aa a c8e98d" quantity 3 Cadena R 36 Entero positivo R 13 No se necesita para la cancelación Solo se necesita para eliminar puestos. Número de puestos que se eliminarán 4.12 Esquema de solicitud: crear pedido inicial Una respuesta simple de la API que verifica que una llamada ha pasado por la autenticación, autorización y validaciones y se está procesando en nuestros sistemas backend. Definición de esquema Ejemplo Tipo de campo status "Aceptar" Cadena message "Se está procesando su pedido." Cadena reference number Cadena 4.13 Esquema de respuesta: actualización de pedido de compra periódico Una respuesta simple de la API que verifica que una llamada ha pasado por la autenticación, autorización y validaciones y se está procesando en nuestros sistemas backend. Definición de esquema Ejemplo Tipo de campo status "ERROR" Cadena message "No existe ese número de contrato" "No se pueden añadir puestos para un producto cancelado con ID de suscripción <ID de suscripción>" Cadena reference number Cadena 31 Manual de referencia del servicio web

32 4.14 Esquema de respuesta: obtener estado del pedido La respuesta de la API de estado devuelve el estado del pedido según el ID de transacción proporcionado. El estado indica si el pedido se está procesando, se ha completado o ha tenido un error con un número de caso para el código de estado. Definición de Tipo de Ejemplo esquema campo status "Correcto", "Error ", "Pedido aceptado" Cadena message "Procesamiento de pedidos" "El pedido se ha creado correctamente". "Error de procesamiento del pedido. Póngase en contacto con Autodesk (código de error 71)" Cadena "Error de procesamiento del pedido. Póngase en contacto con Autodesk CASE# last updated " :15:54 UTC" Cadena 4.15 Esquema de respuesta: eliminar licencias, eliminar productos, cancelar pedidos (solo periódicos) Una respuesta simple de la API que verifica que una llamada ha pasado por la autenticación, autorización y validaciones y se está procesando en nuestros sistemas backend. Definición de esquema Ejemplo Tipo de campo status "ERROR" Cadena message "Esa SKU no está en vigor." Cadena reference number Cadena 4.16 Esquema de respuesta Notificación de SNS A continuación se indican las respuestas de una notificación de SNS. La respuesta proporciona información sobre el estado del pedido realizado. Si se realiza correctamente, el número de la entidad se rellena con el número de pedido de ventas de nuestros sistemas de oficina. Si se produce un error al procesar el pedido, el campo del mensaje proporciona un código de error. Definición de esquema Ejemplo Tipo de campo csn " " Cadena transaction_id " " Cadena status "Correcto", "Error" Cadena message "El pedido se ha creado correctamente". "El pedido de puestos adicionales se ha actualizado correctamente". "Error de procesamiento del pedido. Póngase en contacto con Autodesk (código de error 71)" Cadena entity_number " " Cadena 32 Manual de referencia del servicio web

33 5 Ejemplos de mensajes 5.1 Mensaje de solicitud: cumplimiento de pedidos, pedido inicial, modelo de suscripción periódica 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", 33 Manual de referencia del servicio web

34 "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" ] Mensaje de respuesta: cumplimiento de pedidos, pedido inicial "status": "OK", "message": "Your order is being processed", "reference number": " INITIAL ORDER 9-27 arc " 34 Manual de referencia del servicio web

35 5.2 Mensaje de respuesta: cumplimiento de pedidos, pedido inicial, modelo de suscripción renovable 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", 35 Manual de referencia del servicio web

36 "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" ] Mensaje de respuesta: cumplimiento de pedidos, pedido inicial "status": "OK", "message": "Your order is being processed", "reference number": " INITIAL ORDER 9-27 arc " 36 Manual de referencia del servicio web

37 5.3 Mensaje de solicitud: cumplimiento de pedidos, adición de puestos, modelo de suscripción periódica 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" ] Mensaje de respuesta: cumplimiento de pedidos, adición de puestos, modelo de suscripción periódica "status": "OK", "message": "Your order is being processed", "reference number": " INITIAL ORDER 9-27 arc " 37 Manual de referencia del servicio web

38 5.4 Mensaje de solicitud: cumplimiento de pedidos, adición de puestos, modelo de suscripción renovable 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": [ " " ] ] 38 Manual de referencia del servicio web