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

Transcripción

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

2 CONTENIDO Historial de revisiones Introducción Descripción general Documentación complementaria Para empezar Descripción general del servicio de designación de distribuidores Ventajas del servicio GetPartnerDesignation Información de referencia del servicio GetPartnerDesignation Esquema de solicitud Esquema de respuesta Esquema de error Mensajes de solicitud Mensaje de respuesta Mensaje de respuesta: GetPartnerDesignation con el CSN del distribuidor como entrada Mensaje de respuesta: GetPartnerDesignation con el código de país como entrada Mensajes de error Ejemplo de respuesta de error Historial de revisiones Versión Fecha Autor Comentarios /09/2016 SJ Versión inicial 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 Manual de referencia del servicio web

4 3 Descripción general del servicio de designación de distribuidores Este servicio hace y proporciona lo siguiente: Obtiene la información de cuenta, la cuenta de contrato y la información sobre la experiencia en función del CSN del distribuidor o el país especificados. Valida los CSN y los CSN de distribuidor proporcionados. Si la solicitud no es válida, la respuesta devuelve un error. 3.1 Ventajas del servicio GetPartnerDesignation 1. Se trata de un informe de autoservicio basado en datos en tiempo real. a. Cuando se modifica un contrato, esto se refleja inmediatamente en este informe. b. Reemplaza los informes semanales publicados actualmente en Partner Center (VAR Spez Report Dist) 2. Un servicio web de REST ligero que se puede consumir fácilmente desde cualquier aplicación. 3. La flexibilidad de los distribuidores para obtener la información de la experiencia con un número CSN de distribuidor específico o proporcionando un código de país. 4 Manual de referencia del servicio web

5 4 Información de referencia del servicio GetPartnerDesignation 4.1 Esquema de solicitud Los detalles de los parámetros del mensaje de solicitud se encuentran en la tabla siguiente para GetPartnerDesignation. Elemento Tipo de campo Longitud/formato de entrada Utilización CSN Cadena 10 Obligatorio CountryCode Cadena Código de país ISO de 2 dígitos Obligatorio si no se proporciona el ResellerCSN. ResellerCSN Cadena 10 Obligatorio si no se proporciona el CountryCode. 4.2 Esquema de respuesta Para el envío del intervalo de fechas, se muestran las siguientes columnas. Campo PartnerDesignationList Tipo de campo Matriz de objeto JSON Longitud y formato de salida Descripción AccountCSN Cadena 30 Un identificador exclusivo de una cuenta de empresa/distribuidor/cliente final ParentAccountCSN Cadena 30 CSN de la cuenta principal en la jerarquía (por ejemplo, Doméstico Primordial) AccountName Cadena 255 Nombre de la empresa asociada a la cuenta Address1 Cadena 255 Dirección física de la empresa asociada a la cuenta Address2 Cadena 100 Dirección física de la empresa asociada a la cuenta Address3 Cadena 100 Dirección física de la empresa asociada a la cuenta City Cadena 50 Ciudad del distribuidor ZipCode Cadena 30 Código postal del distribuidor State Cadena 50 Estado del distribuidor Country Cadena 50 País del distribuidor SalesRegion Cadena 40 Región de ventas en el contrato del distribuidor 5 Manual de referencia del servicio web

6 ContractEndDate Formato de fecha ISO Fecha de finalización del contrato del distribuidor ContractType Cadena 255 Tipo de contrato basado en el tipo de distribuidor PartnerHierachy Cadena 255 Cuenta en la jerarquía PartnerTier Cadena 255 Nivel del distribuidor en el contrato del distribuidor ExpertiseList Matriz de objetos JSON ExpertiseType Cadena 255 Tipo de especialización al que está asociado el distribuidor. Expertise Cadena 80 Especialización a la que está asociado el distribuidor. Matriz de objetos JSON error_code Cadena 13 Código de error error_message Cadena 250 Mensaje de error 4.3 Esquema de error Nombre de campo PartnerDesignationList Mensaje de error Código de error Descripción null Un breve resumen que indica el error. Un código con el formato 000XX. 6 Manual de referencia del servicio web

7 4.4 Mensajes de solicitud A continuación se muestran solicitudes de ejemplo de GetPartnerDesignation. [Getting GetPartnerDesignation using Reseller CSN] Message Headers Content-Type: application/json Authorization: Bearer <<Access Token>> CSN: <<CSN>> signature: <<Signed Access Token>> timestamp: <<Timestamp for the signed Access Token>> [Getting GetPartnerDesignation using Country Code] 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 Mensaje de respuesta Nota: Autodesk enviará una respuesta con la siguiente estructura. Los socios pueden cambiar el formato en distintas estructuras en función de sus necesidades Mensaje de respuesta: GetPartnerDesignation con el CSN del distribuidor como entrada "PartnerDesignationList": [ "ZipCode": "560086", "State": "KARNATAKA", "SalesRegion": "INDIA", "PartnerTier": "Gold", 7 Manual de referencia del servicio web

8 "PartnerHierachy": "Domestic Ultimate", "ParentAccountCSN": " ", "ExpertiseList": [ "Expertise": "AutoCAD" "Expertise": "M&E" "ExpertiseType": "Product Group", "Expertise": "Base" "Expertise": "Building" "Expertise": "Civil Infrastructure" "Expertise": "Product Design & Manufacturing" "ExpertiseType": "Product Group", "Expertise": "Open" "Expertise": "Advanced Structure" ], "Country": "India", "ContractType": "IVAR", "ContractEndDate": " ", "City": "Bengaluru", "Address3": null, "Address2": "EBIPBCHKGB", "Address1": "AFAEAFHGDM", "AccountName": "NHFGGLIOAMKJNNEIELFIGCIBDPOLIEON", "AccountCSN": " " ], "error_message": "", "error_code": "" 8 Manual de referencia del servicio web

9 4.5.2 Mensaje de respuesta: GetPartnerDesignation con el código de país como entrada "PartnerDesignationList": [ "ZipCode": "81000", "State": null, "SalesRegion": "Central Europe", "PartnerTier": "Silver", "PartnerHierachy": "Domestic Ultimate", "ParentAccountCSN": " ", "ExpertiseList": [ "ExpertiseType": "Product Group", "Expertise": "Base" "Expertise": "Civil Infrastructure" "ExpertiseType": "Product Group", "Expertise": "Open" "Expertise": "AutoCAD" ], "Country": "Montenegro", "ContractType": "IVAR", "ContractEndDate": " ", "City": "Podgorica", "Address3": null, "Address2": "HKIJFOMGJE", "Address1": "JHOIDNIPME", "AccountName": "KGGLHLGJLOEEDDJCDGMHMGGLPIOMEBGN", "AccountCSN": " " "ZipCode": "81000", "State": null, "SalesRegion": "Central Europe", "PartnerTier": "Bronze", "PartnerHierachy": "Domestic Ultimate", "ParentAccountCSN": " ", "ExpertiseList": [ "Expertise": "AutoCAD" ], 9 Manual de referencia del servicio web

10 "Country": "Montenegro", "ContractType": "IVAR", "ContractEndDate": " ", "City": "Podgorica", "Address3": null, "Address2": null, "Address1": "NECDGMEGDE", "AccountName": "OBJAMNAMMKBAJHJKDHJPGCMMDAKAGPKJ", "AccountCSN": " " "ZipCode": "81000", "State": null, "SalesRegion": "Central Europe", "PartnerTier": "Bronze", "PartnerHierachy": "Domestic Ultimate", "ParentAccountCSN": " ", "ExpertiseList": [ "ExpertiseType": "Product Group", "Expertise": "Base" "ExpertiseType": "Product Group", "Expertise": "Open" "Expertise": "AutoCAD" ], "Country": "Montenegro", "ContractType": "IVAR", "ContractEndDate": " ", "City": "Podgorica", "Address3": null, "Address2": null, "Address1": "HCLKLBBPIB", "AccountName": "MGFHEAHPMLHLPBHHONCODBPDEEILAOAF", "AccountCSN": " " ], "error_message": "", "error_code": "" 10 Manual de referencia del servicio web

11 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 se detecta un error: Número de mensaje Mensaje de error CSN no autorizado El CSN del distribuidor proporcionado no es válido o no tiene un tipo de distribuidor válido. El código de país no es válido. No se han encontrado contratos activos del CSN. Proporcione el ResellerCSN o el CountryCode. Falta el sello horario en el encabezado. Falta la firma en el encabezado. Falta el CSN en el encabezado. Falta la autorización en el encabezado. Token no válido en el encabezado. CSN no válido en el encabezado. Sello horario no válido en el encabezado. Firma no válida en el encabezado. Descripción del error Este error se generará si el CSN del comprador enviado por el distribuidor no es de tipo de Distribuidor principal o Distribuidor. Este error se generará si el CSN de distribuidor proporcionado no tiene un tipo de distribuidor, distribuidor principal, VCP o ISV. Este error se generará si el código de país proporcionado no es válido. Este error se generará si no se ha encontrado ningún contrato activo del CSN del distribuidor. Este error se generará si no se proporciona ninguna de las entradas de ResellerCSN o CountryCode. Este error se generará si no se ha definido el sello horario del encabezado en la solicitud. Este error se generará si no se ha definido la firma del encabezado en la solicitud. Este error se generará si no se ha definido el CSN del encabezado en la solicitud. Este error se generará si no se ha definido la autorización del encabezado en la solicitud. Este error se generará si el valor de la autorización del encabezado es incorrecto o no válido. Este error se generará si el valor del CSN del encabezado es incorrecto o no válido. Este error se generará si el valor del sello horario del encabezado es incorrecto o no válido. Este error se generará si el valor de la firma del encabezado es incorrecto o no válido. 11 Manual de referencia del servicio web

12 4.6.1 Ejemplo de respuesta de error "PartnerDesignationList": null, "error_message": "Please provide ResellerCSN or CountryCode." "error_code": "00004" 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 pueda 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. 12 Manual de referencia del servicio web