API de panel de hardware

  • Artículo

Usa las API de hardware de Microsoft para consultar y crear envíos mediante programación para productos de hardware dentro de la cuenta del Centro de partners de tu organización. Estas API son útiles si su cuenta administra muchos productos y desea automatizar y optimizar el proceso de envío de estos recursos. Estas API usan Microsoft Entra id. (Microsoft Entra ID) para autenticar las llamadas desde la aplicación o el servicio. En los pasos siguientes se describe el proceso completo de uso de la API de hardware de Microsoft:

  1. Estas API solo las pueden usar las cuentas que pertenecen al programa Del Centro de partners de hardware.

  2. Asegúrese de que ha completado los requisitos previos siguientes.

  3. Antes de llamar a un método en la API de hardware de Microsoft, obtenga un token de acceso de identificador de Microsoft Entra, como se muestra a continuación. Después de obtener un token, tiene 60 minutos para utilizar este token en llamadas a la API de envío de Microsoft Store antes de que el token expire. Después de que el token expire, puedes generar uno nuevo.

  4. Llame a la API de hardware de Microsoft.

Completar los requisitos previos para usar la API de hardware de Microsoft

Antes de empezar a escribir código para llamar a la API de hardware de Microsoft, asegúrese de que ha completado los siguientes requisitos previos necesarios.

Asignación de los roles de hardware adecuados a la aplicación de identificador de Microsoft Entra

Una vez completados los requisitos previos anteriores, ahora debemos asignar los roles adecuados para que la aplicación de identificador de Microsoft Entra pueda crear y administrar envíos y etiquetas de envío.

  1. En el Centro de partners, seleccione el icono de engranaje (cerca de la esquina superior derecha del panel) y, a continuación, seleccione Configuración de desarrollador. En el menú Configuración , seleccione Usuarios.

  2. En la página Usuarios, seleccione Microsoft Entra aplicaciones de id. y la aplicación de identificador de Microsoft Entra que representa la aplicación o el servicio que usarás para acceder a los envíos de tu cuenta del Centro de partners.

  3. En esta página, en Roles, seleccione Hardware.

    imagen que muestra la pestaña Hardware de la sección Roles.

    Seleccione Driver Submitter (Remitente del controlador), Shipping Label owner (Propietario de la etiqueta de envío) y, si está disponible, Shipping Label promoter (Promotor de etiquetas de envío). Más información sobre estos roles

Obtención de un token de acceso de identificador de Microsoft Entra

Antes de llamar a cualquiera de los métodos de la API de hardware de Microsoft, primero debe obtener un token de acceso de identificador de Microsoft Entra que pase al encabezado Authorization de cada método de la API. Una vez que haya obtenido un token de acceso, tiene 60 minutos para usarlo antes de que expire. Una vez que expire el token, puede actualizar el token, por lo que puede seguir utilizándolo en llamadas adicionales a la API. Para obtener el token de acceso, sigue las instrucciones en Llamadas de servicio a servicio utilizando las credenciales del cliente para enviar un HTTP POST al punto de conexión https://login.microsoftonline.com/<tenant_id>/oauth2/token. Este es un ejemplo de solicitud.

POST https://login.microsoftonline.com/<tenant_id>/oauth2/token HTTP/1.1
Host: login.microsoftonline.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8

grant_type=client_credentials
&client_id=<your_client_id>
&client_secret=<your_client_secret>
&resource=https://manage.devcenter.microsoft.com

Para el valor de tenant_id en el URI POST y los parámetros client_id y client_secret , especifique el identificador de inquilino, el identificador de cliente y la clave de la aplicación que recuperó del Centro de partners en la sección anterior. Para el parámetro resource, tiene que especificar https://manage.devcenter.microsoft.com.

Una vez que expire el token de acceso, puede actualizarlo siguiendo las instrucciones de Actualización de los tokens de acceso.

Uso de la API de hardware de Microsoft

Después de tener un token de acceso de identificador de Microsoft Entra, puede llamar a métodos en la API de hardware de Microsoft. La API incluye muchos métodos que se agrupan en escenarios. Para crear o actualizar envíos, normalmente se llama a varios métodos en la API de hardware de Microsoft en un orden específico. Para obtener información sobre cada escenario y la sintaxis de cada método, consulta los artículos en la siguiente tabla.

Escenario Descripción
Controladores Obtén, crea y actualiza controladores registrados en tu cuenta del Centro de partners. Para obtener más información sobre estos métodos, consulta los siguientes artículos:

Ejemplos de código

En el ejemplo siguiente se proporciona código detallado que muestra cómo usar la API de hardware de Microsoft junto con una solución completa precompilada de un extremo a otro creada por el equipo de Microsoft Surface y Dispositivos:

ejemplos de API de panel de hardware (GitHub)

Herramienta Surface Dev Center Manager (GitHub)

Ayuda adicional

Si tienes preguntas sobre la API de envío de Microsoft Store o necesitas ayuda para administrar tus envíos con esta API, visita la página de soporte técnico y solicita ayuda.

¿Qué es Microsoft Entra ID?