硬體儀表板 API
使用 Microsoft 硬體 API ,以程式設計方式查詢及建立貴組織合作夥伴中心帳戶內硬體產品的提交。 如果您的帳戶管理許多產品,而且您想要將這些資產的提交程式自動化並優化,這些 API 就很有用。 這些 API 會使用 Azure Active Directory (Azure AD) 來驗證應用程式或服務的呼叫。 下列步驟說明使用 Microsoft 硬體 API 的端對端程式:
這些 API 只能供屬於硬體 合作夥伴中心計畫的帳戶使用。
請確定您已完成下列必要條件。
在 Microsoft 硬體 API 中呼叫方法之前,請先取得 Azure AD 存取權杖,如下所示。 取得權杖之後,在權杖到期之前,您有 60 分鐘的時間可以使用這個權杖呼叫 Microsoft Store 提交 API。 權杖到期之後,您可以產生新的權杖。
呼叫 Microsoft 硬體 API。
完成使用 Microsoft 硬體 API 的必要條件
開始撰寫程式碼以呼叫 Microsoft 硬體 API 之前,請確定您已完成下列必要條件。
您 (或您的組織) 必須具有 Azure AD 目錄,且您必須具備該目錄的全域管理員 \(部分機器翻譯\) 權限。 如果您已經從 Microsoft 使用 Microsoft 365 或其他商務服務,則您已經有 Azure AD 目錄。 否則,您可以在 合作夥伴中心建立新的 Azure AD ,不需額外費用。
如果 Azure AD 應用程式不存在, 您必須建立一個。
您必須 將 Azure AD 應用程式與您的合作夥伴中心帳戶建立關聯 ,並將它指派給 管理員 角色。
收集 您的 Azure AD 應用程式租使用者識別碼、用戶端識別碼和金鑰。 請務必列印或複製此金鑰資訊,因為當您離開金鑰建立頁面之後,將無法再次存取它。
將適當的硬體角色指派給 Azure AD 應用程式
完成上述必要條件之後,我們現在必須指派適當的角色,讓 Azure AD 應用程式可以建立和管理提交和寄送標籤。
從合作夥伴中心,選取儀表板右上角附近的齒輪 (圖示) ,然後選取 [ 開發人員設定]。 在 [ 設定] 功能表中,選取 [ 使用者]。
在 [ 使用者] 頁面上,選取 [Azure AD 應用程式 ] 和代表您將用來存取合作夥伴中心帳戶提交之應用程式或服務的 Azure AD 應用程式。
在此頁面的 [ 角色] 底下,選取 [硬體]。
選取 [驅動程式提交者]、 [出貨標籤擁有者],如果可用, 則選取 [運送標籤] 升級工具。 深入瞭解這些角色
取得 Azure AD 存取權杖
在呼叫 Microsoft 硬體 API 中的任何方法之前,您必須先取得 Azure AD 存取權杖,該權杖會傳遞至 API 中每個方法的 授權 標頭。 在您取得存取權杖之後,您有 60 分鐘的使用時間,之後其便會到期。 權杖到期之後,您可以重新整理權杖,以便繼續在對 API 的進一步呼叫中使用。 若要取得存取權杖,請按照使用用戶端認證的服務對服務呼叫中的指示,將 HTTP POST 傳送至 https://login.microsoftonline.com/<tenant_id>/oauth2/token
端點。 以下是範例要求。
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
針對 POST URI 中的 tenant_id 值,以及 client_id 和 client_secret 參數,指定您在上一節中從合作夥伴中心擷取的應用程式租使用者識別碼、用戶端識別碼和金鑰。 針對 resource 參數,您必須指定 https://manage.devcenter.microsoft.com
。
存取權杖到期之後,您可以依照 重新整理存取權杖中的指示進行重新整理。
使用 Microsoft 硬體 API
擁有 Azure AD 存取權杖之後,您可以在 Microsoft 硬體 API 中呼叫方法。 API 包含許多分組為案例的方法。 若要建立或更新提交,您通常會以特定順序呼叫 Microsoft 硬體 API 中的多個方法。 如需每個案例及每個方法之語法的相關資訊,請參閱下表中的文章。
案例 | 描述 |
---|---|
驅動程式 | 取得、建立及更新註冊至合作夥伴中心帳戶的驅動程式。 如需這些方法的詳細資訊,請參閱下列文章: |
程式碼範例
下列範例提供詳細的程式碼,示範如何使用 Microsoft 硬體 API 以及 Microsoft Surface 和 Devices 小組所建立的完整端對端預建解決方案:
其他說明
如果您有關于 Microsoft Store 提交 API 的問題,或需要使用此 API 管理提交的協助,請造訪 支援頁面 並要求協助。