Manage Product Submissions

Use the following methods in Microsoft Hardware APIs to manage submissions for your products and for getting them signed by Microsoft. For an introduction to Microsoft Hardware APIs, including prerequisites for using the API, see Hardware dashboard API.

https://manage.devcenter.microsoft.com/v1.0/my/hardware/products/

Methods for managing product submissions

Method URI Description
GET https://manage.devcenter.microsoft.com/v1.0/my/hardware/products/{productID} Get status/data for a specific product
GET https://manage.devcenter.microsoft.com/v1.0/my/hardware/products/{productID}/submissions/{submissionId} Get status/data for a specific submission of a product
POST https://manage.devcenter.microsoft.com/v1.0/my/hardware/products Create a new product
POST https://manage.devcenter.microsoft.com/v1.0/my/hardware/products/{productID}/submissions/ Create a new submission for a product
POST https://manage.devcenter.microsoft.com/v1.0/my/hardware/products/{productID}/submissions/{submissionId}/commit Commit a product submission

Create and submit a product for signing

  1. If you have not done so already, complete all the prerequisites for the Microsoft Hardware APIs.

  2. Obtain an Azure AD access token. You must pass this access token to the methods in the Microsoft Store submission API. After you obtain an access token, you have 60 minutes to use it before it expires. After the token expires, you can obtain a new one.

  3. Create a new product by executing the following method in the Microsoft Hardware API. This creates a new in-progress product and allows you to submit packages for this product.

    https://manage.devcenter.microsoft.com/v1.0/my/hardware/products/
    

    The response body contains a Product resource that includes the ID of this product.

  4. Create a submission for this product by executing the following method in the Microsoft Hardware API. Use the ProductID created in the step above.

    https://manage.devcenter.microsoft.com/v1.0/my/hardware/products/{productID}/submissions/
    

    The response body contains a Submission resource which includes the ID of the submission, the shared access signature (SAS) URI for uploading the product (driver) package for the submission to Azure Blob storage. [!NOTE] > A SAS URI provides access to a secure resource in Azure storage without requiring account keys. For background information about SAS URIs and their use with Azure Blob storage, see Shared Access Signatures, Part 1: Understanding the SAS model and Shared Access Signatures, Part 2: Create and use a SAS with Blob storage .

  5. Upload your package to the Azure Blob storage at the location specified by the SAS URI in the previous step. The following C# code example demonstrates how to upload a package to Azure Blob storage using the CloudBlockBlob class in the Azure Storage Client Library for .NET. This example assumes that the package has already been written to a stream object.

    string sasUrl = "https://productingestionbin1.blob.core.windows.net/ingestion/26920f66-b592-4439-9a9d-fb0f014902ec?sv=2014-02-14&sr=b&sig=usAN0kNFNnYE2tGQBI%2BARQWejX1Guiz7hdFtRhyK%2Bog%3D&se=2016-06-17T20:45:51Z&sp=rwl";
    Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob blockBob = 
        new Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob(new System.Uri(sasUrl));
    await blockBob.UploadFromStreamAsync(stream);
    
  6. Commit the product submission by executing the following method. This will alert Hardware Dev Center that you are done with your product submission and validation will be started for the submission.

    https://manage.devcenter.microsoft.com/v1.0/my/hardware/products/{productID}/submissions/{submissionId}/commit
    
  7. Check on the commit status by executing the following method to get the status of the product submission.

    https://manage.devcenter.microsoft.com/v1.0/my/hardware/products/{productID}/submissions/{submissionId}
    

    To confirm the submission status, review the commitStatus value in the response body. This value should change from commitReceived to commitCompleted if the request succeeds or to commitFailed if there are errors in the request. If there are errors, the error field contains further details about the error.

Code examples

The following code examples demonstrates how to use the Microsoft Hardware API:

Data resources

The Microsoft Hardware APIs methods for creating and managing product data use the following JSON data resources:

See also

Hardware dashboard API samples (GitHub)