Hardware dashboard API
Usare le API hardware Microsoft per eseguire query a livello di codice e creare invii per i 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:
Queste API possono essere usate solo dagli account appartenenti al programma Del Centro per i partner hardware.
Assicurarsi di aver completato i prerequisiti seguenti.
Prima di chiamare un metodo nell'API Hardware Microsoft, ottenere un token di accesso microsoft Entra ID, come illustrato di seguito. Dopo aver ottenuto un token, hai 60 minuti per usare questo token nelle chiamate all'API di invio a Microsoft Store prima della scadenza del token. Dopo la scadenza del token, è possibile generare un nuovo token.
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.
L'utente (o l'organizzazione) deve disporre di una directory MICROSOFT Entra ID e disporre dell'autorizzazione di amministratore globale per la directory. Se si usa già Microsoft 365 o altri servizi aziendali di Microsoft, si dispone già di Microsoft Entra ID directory. In caso contrario, è possibile creare un nuovo ID Entra Microsoft nel Centro per i partner senza costi aggiuntivi.
Se non esiste già un'applicazione Microsoft Entra ID, è necessario crearne una.
È necessario associare un'applicazione Microsoft Entra ID all'account del Centro per i partner e assegnargli il ruolo manager .
Raccogliere l'ID tenant dell'applicazione Microsoft Entra ID, l'ID client e la chiave. Assicurarsi di stampare o copiare queste informazioni chiave, perché non sarà possibile accedervi di nuovo dopo aver lasciato la pagina di creazione della chiave.
Assegnazione dei ruoli hardware appropriati all'applicazione Microsoft Entra ID
Dopo aver completato i prerequisiti precedenti, è ora necessario assegnare i ruoli appropriati in modo che l'applicazione Microsoft Entra ID possa creare e gestire gli invii e le etichette di spedizione.
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.
Nella pagina Utenti selezionare Applicazioni Microsoft Entra ID e l'applicazione Microsoft Entra ID che rappresenta l'app o il servizio che userai per accedere agli invii per il tuo account del Centro per i partner.
In Questa pagina, in Ruoli, selezionare Hardware.
Selezionare Driver Submitter, Shipping Label Owner (Proprietario etichetta spedizione) e, se disponibile, Shipping Label promoter (Promotore etichetta spedizione). Altre informazioni su questi ruoli
Ottenere un token di accesso microsoft Entra ID
Prima di chiamare uno dei metodi nell'API Hardware Microsoft, è necessario ottenere un token di accesso di Microsoft Entra ID passato all'intestazione Authorization 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, seguire le istruzioni riportate in Chiamate da servizio a servizio mediante le credenziali client per inviare un HTTP POST all'endpoint https://login.microsoftonline.com/<tenant_id>/oauth2/token. Di seguito è riportata 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 in POST URI e per i parametri client_id e client_secret, specificare l'ID tenant, l'ID client e la chiave per l'applicazione recuperati 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 aver ottenuto un token di accesso microsoft Entra ID, è 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, vedere 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, vedere 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 predefinita end-to-end creata dal team di Microsoft Surface and Devices:
Informazioni aggiuntive
Se hai domande sull'API per l'invio in Microsoft Store o hai bisogno di assistenza per gestire gli invii con questa API, visita la pagina del supporto e richiedi assistenza.