API de panel de hardware
Use las API de hardware de Microsoft para consultar y crear envíos de hardware mediante programación en la cuenta del Centro de partners de la 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 para autenticar las llamadas desde la aplicación o el servicio. En los pasos siguientes se describe el proceso completo para utilizar la API de hardware de Microsoft:
Estas API solo se pueden usar en las cuentas que pertenecen al programa Centro de partners de hardware.
Asegúrese de haber completado los requisitos siguientes.
Antes de llamar a un método en la API de hardware de Microsoft, obtenga un token de acceso de de Microsoft Entra ID, 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, puede generar uno nuevo.
Llame a la API de hardware de Microsoft.
Complete 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 necesarios.
Usted (o su organización) tiene que tener un directorio de Microsoft Entra ID y el permiso de Administrador global para el directorio. Si usa Microsoft 365 u otros servicios empresariales de Microsoft, ya tiene el directorio de Microsoft Entra ID. De lo contrario, puede crear una nueva instancia de Microsoft Entra ID en el Centro de partners sin cargo adicional.
Si aún no existe una aplicación de Microsoft Entra ID, debe crear una.
Debe asociar una aplicación de Microsoft Entra ID a su cuenta del Centro de partners y asignarle el rol de Administrador.
Recopile el identificador de inquilino de la aplicación de Microsoft Entra ID, el identificador de cliente y la clave. Asegúrese de imprimir o copiar esta información de claves, ya que no podrá acceder a ella nuevamente después de salir de la página de creación de claves.
Asignación de los roles de hardware adecuados a la aplicación Microsoft Entra ID
Una vez completados los requisitos previos anteriores, ahora debemos asignar los roles adecuados para que la aplicación Microsoft Entra ID pueda crear y administrar envíos y etiquetas de envío.
En el Centro de partners, seleccione el icono del engranaje (cerca de la esquina superior derecha del panel) y, a continuación, seleccione Configuración para desarrolladores. En el menú Configuración, seleccione Usuarios.
En la página Usuarios, seleccione Aplicaciones de Microsoft Entra ID y la aplicación de Microsoft Entra ID que representa la aplicación o el servicio que usará para acceder a los envíos de su cuenta del Centro de partners.
En esta página, en Roles, seleccione Hardware.
Seleccione Remitente del controlador, Propietario de la etiqueta de envío y, si está disponible, Promotor de etiquetas de envío. Más información sobre estos roles
Obtenga un token de acceso de Microsoft Entra ID
Antes de llamar a cualquiera de los métodos de la API de hardware de Microsoft, primero tiene que obtener un token de Microsoft Entra ID que pase al encabezado de autorización 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 actualizarlo para poder seguir utilizándolo en llamadas adicionales a la API. Para obtener el token de acceso, siga las instrucciones de Llamadas entre servicios mediante las credenciales del cliente para enviar una solicitud HTTP POST al punto de conexión https://login.microsoftonline.com/<tenant_id>/oauth2/token. Esta es una solicitud de ejemplo.
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 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 caduque 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 Microsoft Entra ID, 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 acerca de cada escenario y la sintaxis de cada método, consulte los artículos en la tabla siguiente:
| Escenario | Descripción |
|---|---|
| Controladores | Obtenga, cree y actualice los controladores registrados en su cuenta del Centro de partners. Para obtener más información sobre estos métodos, vea los artículos siguientes: |
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 de un extremo a otro creado previamente por el equipo de Microsoft Surface y Dispositivos:
- Ejemplos de API del panel de hardware (GitHub)
- Herramienta de administrador de centro de desarrollo Surface (GitHub)
Ayuda adicional
Si tiene preguntas sobre la API de envío de Microsoft Store o necesita ayuda para administrar los envíos con esta API, consulte la página de soporte y la ayuda para solicitudes.