Share via


API dashboard hardware

Usare le API hardware Microsoft per eseguire query a livello di codice e creare invii per prodotti hardware all'interno dell'account del Centro per i partner dell'organizzazione. Queste API sono utili se l'account gestisce molti prodotti e si vuole automatizzare e ottimizzare il processo di invio per questi asset. Queste API usano Microsoft Entra ID (Microsoft Entra ID) per autenticare le chiamate dall'app o dal servizio. I passaggi seguenti descrivono il processo end-to-end dell'uso dell'API Hardware Microsoft:

  1. Queste API possono essere usate solo dagli account appartenenti al programma Centro per i partner hardware.

  2. Assicurarsi di aver completato i prerequisiti seguenti.

  3. Prima di chiamare un metodo nell'API Hardware Microsoft, ottenere un token di accesso ID Microsoft Entra, come illustrato di seguito. Dopo aver ottenuto un token, sono disponibili 60 minuti per usare questo token nelle chiamate all'API di invio di Microsoft Store prima della scadenza del token. Dopo la scadenza del token, puoi generare un nuovo token.

  4. Chiamare l'API Hardware Microsoft.

Completare i prerequisiti per l'uso dell'API Hardware Microsoft

Prima di iniziare a scrivere codice per chiamare l'API Hardware Microsoft, assicurarsi di aver completato i prerequisiti necessari seguenti.

Assegnazione dei ruoli hardware appropriati all'applicazione ID Microsoft Entra

Dopo aver completato i prerequisiti precedenti, è ora necessario assegnare i ruoli appropriati in modo che l'applicazione ID Microsoft Entra possa creare e gestire gli invii e le etichette di spedizione.

  1. Nel Centro per i partner selezionare l'icona a forma di ingranaggio (nell'angolo superiore destro del dashboard) e quindi selezionare Impostazioni sviluppatore. Nel menu Impostazioni selezionare Utenti.

  2. Nella pagina Utenti selezionare Microsoft Entra applicazioni ID e l'applicazione ID Microsoft Entra che rappresenta l'app o il servizio che si userà per accedere agli invii per l'account del Centro per i partner.

  3. In Ruoli in Questa pagina selezionare Hardware.

    immagine che mostra la scheda Hardware nella sezione Ruoli.

    Selezionare Driver Submitter, Shipping Label owner (Proprietario dell'etichetta di spedizione) e, se disponibile, promotore dell'etichetta di spedizione. Altre informazioni su questi ruoli

Ottenere un token di accesso id Microsoft Entra

Prima di chiamare uno dei metodi nell'API Hardware Microsoft, è prima necessario ottenere un token di accesso ID Microsoft Entra passato all'intestazione Di autorizzazione di ogni metodo nell'API. Dopo aver ottenuto un token di accesso, questo sarà disponibile per 60 minuti prima della scadenza. Dopo la scadenza del token, è possibile aggiornare il token, quindi è possibile continuare a usarlo in altre chiamate all'API. Per ottenere il token di accesso, segui le istruzioni in Chiamate da servizio a servizio tramite le credenziali del client per inviare un comando POST HTTP all'endpoint https://login.microsoftonline.com/<tenant_id>/oauth2/token. Ecco una richiesta di esempio.

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

Per il valore tenant_id nell'URI POST e nei parametridi client_id e client_secret, specificare l'ID tenant, l'ID client e la chiave per l'applicazione recuperata dal Centro per i partner nella sezione precedente. Per il parametro resource è necessario specificare https://manage.devcenter.microsoft.com.

Dopo la scadenza del token di accesso, è possibile aggiornarlo seguendo le istruzioni riportate in Aggiornamento dei token di accesso.

Usare l'API Hardware Microsoft

Dopo avere un token di accesso id Microsoft Entra, è possibile chiamare i metodi nell'API Hardware Microsoft. L'API include molti metodi raggruppati in scenari. Per creare o aggiornare gli invii, in genere si chiamano più metodi nell'API Hardware Microsoft in un ordine specifico. Per informazioni su ogni scenario e sulla sintassi di ogni metodo, vedi gli articoli nella tabella seguente.

Scenario Descrizione
Driver Ottenere, creare e aggiornare i driver registrati nell'account del Centro per i partner. Per altre informazioni su questi metodi, vedi gli articoli seguenti:

Esempi di codice

L'esempio seguente fornisce codice dettagliato che illustra come usare l'API Hardware Microsoft insieme a una soluzione completa end-to-end creata dal team di Microsoft Surface and Devices:

esempi di API del dashboard hardware (GitHub)

Strumento Surface Dev Center Manager (GitHub)

Guida aggiuntiva

Se si hanno domande sull'API di invio di Microsoft Store o è necessaria assistenza per la gestione degli invii con questa API, visitare la pagina di supporto e richiedere assistenza.

Cos'è Microsoft Entra ID?