Microsoft Store-indienings-API voor MSI- of EXE-app

Gebruik de Microsoft Store-inzendings-API voor MSI- of EXE-app om programmatisch query's uit te voeren en verzendingen te maken voor MSI- of EXE-apps voor het Partnercentrum-account van uw organisatie. Deze API is handig als uw account veel apps beheert en u het indieningsproces voor deze assets wilt automatiseren en optimaliseren. Deze API maakt gebruik van Microsoft Entra ID om de aanroepen van uw app of service te verifiëren.

In de volgende stappen wordt het end-to-end-proces beschreven voor het gebruik van de Microsoft Store-inzendings-API:

1. Zorg ervoor dat u alle vereisten hebt voltooid.
2. Voordat u een methode aanroept in de Microsoft Store-indienings-API, moet u een Microsoft Entra ID-toegangstoken verkrijgen. Nadat u een token hebt verkregen, hebt u 60 minuten de tijd om dit token te gebruiken in aanroepen naar de Microsoft Store-inzendings-API voordat het token verloopt. Nadat het token is verlopen, kunt u een nieuw token genereren.
3. Roep de Microsoft Store-indienings-API aan voor MSI- of EXE-app.

Stap 1: Voltooi vereisten voor het gebruik van de Microsoft Store-inzendings-API

Voordat u begint met het schrijven van code voor het aanroepen van de Microsoft Store-inzendings-API voor MSI- of EXE-app, moet u ervoor zorgen dat u aan de volgende vereisten voldoet.

• u (of uw organisatie) moet beschikken over een Microsoft Entra ID-directory en u moet de machtiging Globale beheerder voor die directory hebben. Als u al Microsoft 365 of andere zakelijke diensten van Microsoft gebruikt, hebt u al een Microsoft Entra ID-directory. Anders kunt u zonder extra kosten een nieuwe Microsoft Entra-id maken in het Partnercentrum .
• U moet een Microsoft Entra ID-toepassing koppelen aan uw Partnercentrum-account en uw tenant-id, client-id en -sleutel verkrijgen. U hebt deze waarden nodig om een Microsoft Entra ID-toegangstoken te verkrijgen, dat u gaat gebruiken in aanroepen naar de Microsoft Store-inzendings-API.
• Bereid uw app voor op gebruik met de Microsoft Store-inzendings-API:
  • Als uw app nog niet bestaat in Partnercentrum, moet u uw app aanmaken door de naam te reserveren in Partnercentrum. U kunt de Microsoft Store-inzendings-API niet gebruiken om een app te maken in partnercentrum; u moet in partnercentrum werken om het te maken en daarna kunt u de API gebruiken om toegang te krijgen tot de app en programmatisch indieningen voor de app te maken.
  • Voordat u een inzending voor een bepaalde app kunt maken met behulp van deze API, moet u eerst één inzending maken voor de app in partnercentrum, inclusief het beantwoorden van de vragenlijst voor leeftijdsclassificaties . Nadat u dit hebt uitgevoerd, kunt u programmatisch nieuwe inzendingen voor deze app maken met behulp van de API.
  • Als u een app-inzending maakt of bijwerkt en u een nieuw pakket moet opnemen, de pakketdetails voorbereiden.
  • Als u een app-inzending maakt of bijwerkt en u schermafbeeldingen of afbeeldingen voor de Store-vermelding moet opnemen, de app-schermafbeeldingen en -afbeeldingenvoorbereiden.

Een Microsoft Entra ID-toepassing koppelen aan uw Partnercentrum-account

Voordat u de Microsoft Store-indienings-API voor MSI- of EXE-app kunt gebruiken, moet u een Microsoft Entra-id-toepassing koppelen aan uw Partnercentrum-account, de tenant-id en client-id voor de toepassing ophalen en een sleutel genereren. De Microsoft Entra ID-toepassing vertegenwoordigt de app of service waaruit u de Microsoft Store-inzendings-API wilt aanroepen. U hebt de tenant-id, client-id en -sleutel nodig om een Microsoft Entra ID-toegangstoken te verkrijgen dat u doorgeeft aan de API.

1. Koppel in Partnercentrum het Partnercentrum-account van uw organisatie aan de Microsoft Entra ID-adreslijst van uw organisatie.
2. Voeg vervolgens op de pagina Gebruikers in het gedeelte Accountinstellingen van partnercentrum de Microsoft Entra-id-toepassing toe die de app of service vertegenwoordigt die u gebruikt voor toegang tot inzendingen voor uw PartnerCentrum-account. Zorg ervoor dat u deze toepassing de rol Manager toewijst. Als de toepassing nog niet bestaat in uw Microsoft Entra ID-map, kunt u een nieuwe Microsoft Entra ID-toepassing maken in Partnercentrum.
3. Ga terug naar de pagina Gebruikers, klik op de naam van uw Microsoft Entra ID-toepassing om naar de toepassingsinstellingen te gaan en kopieer de waarden voor tenant-id en client-id.
4. Als u een nieuwe sleutel of clientgeheim wilt toevoegen, raadpleegt u de volgende instructies of raadpleegt u de instructies voor het registreren van de app via Azure Portal:

Ga als volgende te werk om uw app te registreren:

1. Meld u aan bij het Azure-portaal.

2. Als u toegang hebt tot meerdere tenants, gebruikt u het filter Mappen en abonnementen in het bovenste menu om over te schakelen naar de tenant waarin u de toepassing wilt registreren.

3. Zoek en selecteer Microsoft Entra ID Directory.

4. Selecteer onder Beheren de app-registraties > Selecteer uw toepassing.

5. Selecteer Certificaten en geheimen Clientgeheimen >> Nieuw clientgeheim.

6. Voeg een beschrijving voor uw clientgeheim toe.

7. Selecteer een vervaldatum voor het geheim of geef een aangepaste levensduur op.

8. De levensduur van het clientgeheim is beperkt tot twee jaar (24 maanden) of minder. U kunt geen aangepaste levensduur opgeven die langer is dan 24 maanden.

   Opmerking

   Microsoft raadt u aan een verloopwaarde van minder dan 12 maanden in te stellen.

9. Selecteer Toevoegen.

10. Registreer de waarde van het geheim voor gebruik in de toepassingscode van uw client. Deze geheimwaarde wordt nooit meer weergegeven nadat u deze pagina hebt verlaten.

Stap 2: een Microsoft Entra ID-toegangstoken verkrijgen

Voordat u een van de methoden aanroept in de Microsoft Store-indienings-API voor MSI- of EXE-app, moet u eerst een Microsoft Entra ID-toegangstoken verkrijgen dat u doorgeeft aan de autorisatieheader van elke methode in de API. Nadat u een toegangstoken hebt verkregen, hebt u 60 minuten om het te gebruiken voordat het verloopt. Nadat het token is verlopen, kunt u het token vernieuwen, zodat u het kunt blijven gebruiken in verdere aanroepen naar de API.

Om het toegangstoken te verkrijgen, volgt u de instructies in Service-naar-service-aanroepen met clientreferenties om een HTTP POST-verzoek te verzenden naar het https://login.microsoftonline.com/<tenant_id>/oauth2/token-eindpunt. Hier volgt een voorbeeldaanvraag.

POST https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/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>
&scope=https://api.store.microsoft.com/.default

Geef voor de tenant_id waarde in de POST-URI en de client_id en client_secret parameters de tenant-id, client-id en de sleutel op voor uw toepassing die u in de vorige sectie hebt opgehaald uit Partner Center. Voor de bereikparameter moet u opgeven https://api.store.microsoft.com/.default.

Nadat uw toegangstoken is verlopen, kunt u het vernieuwen door de instructies hier te volgen.

Voor voorbeelden die laten zien hoe u een toegangstoken kunt verkrijgen met behulp van C# of Node.js, raadpleegt u de codevoorbeelden voor de Microsoft Store-indienings-API voor MSI- of EXE-app.

Stap 3: de Microsoft Store-indienings-API gebruiken

Nadat u een Toegangstoken voor Microsoft Entra ID hebt, kunt u methoden aanroepen in de Microsoft Store-indienings-API voor MSI- of EXE-app. De API bevat veel methoden die zijn gegroepeerd in scenario's voor apps. Als u verzendingen wilt maken of bijwerken, roept u doorgaans meerdere methoden in een specifieke volgorde aan. Zie de volgende secties voor informatie over elk scenario en de syntaxis van elke methode:

Basis-URL

De basis-URL voor de Microsoft Store-indienings-API voor exe- of MSI-app is: https://api.store.microsoft.com

API-contracten

API voor het ophalen van metagegevens van de huidige conceptindiening

Haalt metagegevens op in elke module (vermeldingen, eigenschappen of beschikbaarheid) onder de huidige conceptinzending.

Pad [Alle modules]: /submission/v1/product/{productId}/metadata?languages={languages}&includelanguagelist={true/false}
Pad [enkele module]: /submission/v1/product/{productId}/metadata/{moduleName}?languages={languages}&includelanguagelist={true/false}
Methode : GET

padparameters

Query-parameters

vereiste headers

Antwoordheaders

antwoordparameters

Huidige metagegevens-API voor indiening bijwerken

Hiermee worden metagegevens in elke module bijgewerkt onder conceptinzending. De API-controles

• Voor actieve inzending. Indien aanwezig, mislukt met foutbericht.
• Als alle modules de gereed status hebben om de Concept opslaan-bewerking toe te staan.
• Elk veld in de inzending wordt gevalideerd volgens de vereisten van de Store
• Validatieregels voor systeemvereistedetails:
  • Toegestane waarden in hardwareItemType = Geheugen: 300 MB, 750 MB, 1 GB, 2 GB, 4 GB, 6 GB, 8 GB, 12 GB, 16 GB, 20 GB
  • Toegestane waarden in hardwareItemType = DirectX: DX9, DX10, DX11, DX12-FEATURELEVEL11, DX12-FEATURELEVEL12
  • Toegestane waarden in hardwareItemType = Video_Memory: 1 GB, 2 GB, 4 GB, 6 GB

pad [Volledige module-update]: /submission/v1/product/{productId}/metadata
Methode : PUT

pad [modulepatchupdate]: /submission/v1/product/{productId}/metadata
methode: PATCH

API-gedrag

In het geval van de API voor volledige module-updates: volledige modulegegevens moeten aanwezig zijn in Aanvraag voor volledige update van elk veld. Elk veld dat niet aanwezig is in Aanvraag, wordt de standaardwaarde gebruikt om de huidige waarde voor die specifieke module te overschrijven.
In het geval van de Patch Module Update-API hoeven in het verzoek alleen velden te worden opgenomen die moeten worden bijgewerkt. Deze veldwaarden uit Aanvraag overschrijven hun bestaande waarden, waarbij alle andere velden die niet aanwezig zijn in de aanvraag, hetzelfde als de huidige voor die specifieke module behouden blijven.

padparameters

vereiste headers

Verzoekparameters

Markten

categorieën en subcategorieën

Talen

Voorbeeldaanvraag

{
    "availability":{
        "markets": ["US"],
        "discoverability": "DISCOVERABLE",
        "enableInFutureMarkets": true,
        "pricing": "PAID",
        "freeTrial": "NO_FREE_TRIAL"
    },
    "properties":{
        "isPrivacyPolicyRequired": true,
        "privacyPolicyUrl": "http://contoso.com",
        "website": "http://contoso.com",
        "supportContactInfo": "http://contoso.com",
        "certificationNotes": "Certification Notes",
        "category": "DeveloperTools",
        "subcategory": "Database",
        "productDeclarations": {
            "dependsOnDriversOrNT": false,
            "accessibilitySupport": false,
            "penAndInkSupport": false
        },
        "isSystemFeatureRequired": [
        {
            "isRequired": true,
                "isRecommended": false,
                "hardwareItemType": "Touch"
            },
            {
                "isRequired": true,
                "isRecommended": false,
                "hardwareItemType": "Keyboard"
            },
            {
                "isRequired": false,
                "isRecommended": false,
                "hardwareItemType": "Mouse"
            },
            {
                "isRequired": false,
                "isRecommended": false,
                "hardwareItemType": "Camera"
            },
            {
                "isRequired": false,
                "isRecommended": false,
                "hardwareItemType": "NFC_HCE"
            },
            {
                "isRequired": false,
                "isRecommended": false,
                "hardwareItemType": "NFC_Proximity"
            },
            {
                "isRequired": false,
                "isRecommended": false,
                "hardwareItemType": "Bluetooth_LE"
            },
            {
                "isRequired": false,
                "isRecommended": false,
                "hardwareItemType": "Telephony"
            },
            {
                "isRequired": false,
                "isRecommended": false,
                "hardwareItemType": "Microphone"
            }
        ],
        "systemRequirementDetails": [
            {
                "minimumRequirement": "1GB",
                "recommendedRequirement": "4GB",
                "hardwareItemType": "Memory"
            },
            {
                "minimumRequirement": "",
                "recommendedRequirement": "",
                "hardwareItemType": "DirectX"
            },
            {
                "minimumRequirement": "",
                "recommendedRequirement": "",
                "hardwareItemType": "Video_Memory"
            },
            {
                "minimumRequirement": "",
                "recommendedRequirement": "",
                "hardwareItemType": "Processor"
            },
            {
                "minimumRequirement": "",
                "recommendedRequirement": "",
                "hardwareItemType": "Graphics"
            }
        ]
    },
    "listings":{
        "language": "en-us",
        "description": "Description",
        "whatsNew": "What's New",
        "productFeatures": ["Feature 1"],
        "shortDescription": "Short Description",
        "searchTerms": ["Search Ter 1"],
        "additionalLicenseTerms": "License Terms",
        "copyright": "Copyright Information",
        "developedBy": "Developer Details",
        "sortTitle": "Product 101",
        "requirements": [
            {
                "minimumHardware": "Pentium4",
                "recommendedHardware": "Corei9"
            }
        ],
        "contactInfo": "contactus@contoso.com"               
    },      
    "listingsToAdd": ["en-au"],
    "listingsToRemove": ["en-gb"]
}

Antwoordheaders

antwoordparameters

Voorbeeldantwoord

{
    "isSuccess": true,
    "errors": [{
        "code": "badrequest",
        "message": "Error Message 1",
        "target": "listings"
        }, {
        "code": "warning",
        "message": "Warning Message 1",
        "target": "properties"
    }],
    "responseData": {
        "pollingUrl": "/submission/v1/product/{productId}/submission/{submissionId}/status",
        "ongoingSubmissionId": ""
    } 
}

Huidige conceptpakketten ophalen via de API

Haalt pakketdetails op in de huidige conceptinzending.

Pad [Alle pakketten]: /submission/v1/product/{productId}/packages
Methode : GET

Path [enkelvoudig pakket]: /submission/v1/product/{productId}/packages/{packageId}
Methode : GET

padparameters

vereiste headers

Antwoordheaders

antwoordparameters

voorbeeldantwoord

{   
    "isSuccess": true,
    "errors": [{
        "code": "badrequest",
        "message": "Error Message 1",
        "target": "listings"
    }, {
        "code": "warning",
        "message": "Warning Message 1",
        "target": "properties"
    }],
    "responseData":{
        "packages":[{
            "packageId": "pack0832",
            "packageUrl": "https://www.contoso.com/downloads/1.1/setup.exe",
            "languages": ["en-us"],
            "architectures": ["X86"],
            "isSilentInstall": true,
            "installerParameters": "/s",
            "genericDocUrl": "https://docs.contoso.com/doclink",
            "errorDetails": [{
                "errorScenario": "rebootRequired",
                "errorScenarioDetails": [{
                    "errorValue": "ERR001001",
                    "errorUrl": "https://errors.contoso.com/errors/ERR001001"
                }]
            }],
            "packageType": "exe",
        }]
    }
}

Huidige api voor conceptpakketten bijwerken

Hiermee worden pakketdetails bijgewerkt onder de huidige conceptinzending.

pad [Volledige module-update]: /submission/v1/product/{productId}/packages
Methode : PUT

Pad [Bijwerken van enkele pakketten]: /submission/v1/product/{productId}/packages/{packageId}
methode: PATCH

API-gedrag

In het geval van de API voor volledige module-updates: volledige pakketgegevens moeten aanwezig zijn in aanvraag voor volledige update van elk veld. Elk veld dat niet aanwezig is in de aanvraag, wordt de standaardwaarde gebruikt om de huidige waarde voor die specifieke module te overschrijven. Dit resulteert in het overschrijven van alle bestaande pakketten met een nieuwe set pakketten uit het verzoek. Dit resulteert in het opnieuw genereren van pakket-id's en de gebruiker moet GET Packages-API aanroepen voor de nieuwste pakket-id's.

In het geval van API voor update van één pakket: alleen velden die moeten worden bijgewerkt voor een bepaald pakket, moeten aanwezig zijn in de aanvraag. Deze veldwaarden van de aanvraag overschrijven hun bestaande waarden, waarbij alle andere velden die niet aanwezig zijn in de aanvraag, hetzelfde als actueel voor dat specifieke pakket worden overschreven. Andere pakketten in de set blijven ongewijzigd.

padparameters

vereiste headers

Verzoekparameters

Voorbeeldaanvraag [volledige module-update]

{
    "packages":[{
        "packageUrl": "https://www.contoso.com/downloads/1.1/setup.exe",
        "languages": ["en-us"],
        "architectures": ["X86"],
        "isSilentInstall": true,
        "installerParameters": "/s",
        "genericDocUrl": "https://docs.contoso.com/doclink",
        "errorDetails": [{
            "errorScenario": "rebootRequired",
            "errorScenarioDetails": [{
                "errorValue": "ERR001001",
                "errorUrl": "https://errors.contoso.com/errors/ERR001001"
            }]
        }],
        "packageType": "exe",
    }]
}

voorbeeldaanvraag [update voor één pakketpatch]

{
    "packageUrl": "https://www.contoso.com/downloads/1.1/setup.exe",
    "languages": ["en-us"],
    "architectures": ["X86"],
    "isSilentInstall": true,
    "installerParameters": "/s",
    "genericDocUrl": "https://docs.contoso.com/doclink",
    "errorDetails": [{
        "errorScenario": "rebootRequired",
        "errorScenarioDetails": [{
            "errorValue": "ERR001001",
            "errorUrl": "https://errors.contoso.com/errors/ERR001001"
        }]
    }],
    "packageType": "exe",
}

Antwoordheaders

antwoordparameters

voorbeeldantwoord

{
    "isSuccess": true,
    "errors": [{
        "code": "badrequest",
        "message": "Error Message 1",
        "target": "listings"
        }, {
        "code": "warning",
        "message": "Warning Message 1",
        "target": "properties"
    }],
    "responseData": {
        "pollingUrl": "/submission/v1/product/{productId}/submission/{submissionId}/status",
        "ongoingSubmissionId": ""
    } 
}

API voor commit-pakketten

Hiermee wordt de nieuwe set pakketten vastgelegd die zijn bijgewerkt met behulp van Pakketupdate-API's onder de huidige conceptindiening. Deze API retourneert een polling-URL om het uploaden van pakketten bij te houden.

Pad: /submission/v1/product/{productId}/packages/commit
methode: POST

padparameters

vereiste headers

Antwoordheaders

antwoordparameters

voorbeeldantwoord

{
    "isSuccess": true,
    "errors": [{
        "code": "badrequest",
        "message": "Error Message 1",
        "target": "listings"
        }, {
        "code": "warning",
        "message": "Warning Message 1",
        "target": "properties"
    }],
    "responseData": {
        "pollingUrl": "/submission/v1/product/{productId}/status",
        "ongoingSubmissionId": ""
    } 
}

Huidige api voor conceptvermeldingsassets ophalen

Hiermee worden itemdetails opgehaald onder de huidige conceptinzending.

Pad: /submission/v1/product/{productId}/listings/assets?languages={languages}
Methode : GET

padparameters

Query-parameters

vereiste headers

Antwoordheaders

antwoordparameters

voorbeeldantwoord

{   
"isSuccess": true,
    "errors": [{
        "code": "badrequest",
        "message": "Error Message 1",
        "target": "listings"
        }, {
        "code": "warning",
        "message": "Warning Message 1",
        "target": "properties"
    }],
    "responseData":{
        "listingAssets": [{
            "language": "en-us",
            "storeLogos": [
                {
                    "id": "1234567890abcdefgh",
                    "assetUrl": "https://contoso.com/blob=1234567890abcdefgh",
                    "imageSize": {
                        "width": 2160,
                        "height": 2160
                    }
                }
            ],
            "screenshots": [
                {
                    "id": "1234567891abcdefgh",
                    "assetUrl": "https://contoso.com/blob=1234567891abcdefgh",
                    "imageSize": {
                        "width": 2160,
                        "height": 2160
                    }
                }
            ]
        }]
    }
}

Api voor vermeldingen van assets maken

Hiermee maakt u een nieuwe asset-upload voor de huidige conceptinzending.

Bijwerken van de lijst van assets

Microsoft Store Submission-API voor EXE- of MSI-app maakt gebruik van door runtime gegenereerde SAS-URL's naar Blob Stores voor elke afzonderlijke upload van afbeeldingsassets, samen met een Doorvoer-API-aanroep nadat het uploaden is geslaagd. Als u de mogelijkheid wilt hebben om vermeldingsassets bij te werken en op zijn beurt landinstellingen in de vermeldingsmodule toe te voegen of te verwijderen, kunt u de volgende methode gebruiken:

1. Gebruik de API voor het maken van vermeldingsassets om verzoeken in te dienen voor het uploaden van assets, samen met de taal, het type en het aantal assets.
2. Op basis van het aantal aangevraagde assets worden asset-id's op aanvraag gemaakt en wordt een SAS-URL voor de korte termijn gemaakt en teruggestuurd in de responsebody als onderdeel van de assets. U kunt deze URL gebruiken om afbeeldingsassets van een specifiek type te uploaden met behulp van HTTP-clients [Put Blob (REST API) - Azure Storage | Microsoft Docs].
3. Na het uploaden kunt u de API voor het vastleggen van vermogensvermeldingen gebruiken om ook de nieuwe asset-ID-informatie te verzenden welke eerder is ontvangen uit de vorige API-aanroep. De enkele API zal na validatie de gegevens van de vermogensbestanddelen van de vermelding intern vastleggen.
4. Deze aanpak overschrijft effectief de volledige set eerdere afbeeldingen van het type activa voor een specifieke taal die in de aanvraag wordt verzonden. Daarom worden eerder geüploade assets verwijderd.

Pad: /submission/v1/product/{productId}/listings/assets/create
methode: POST

padparameters

vereiste headers

Verzoekparameters

Antwoordheaders

antwoordparameters

voorbeeldantwoord

{
    "isSuccess": true,
    "errors": [{
        "code": "badrequest",
        "message": "Error Message 1",
        "target": "listings"
        }, {
        "code": "warning",
        "message": "Warning Message 1",
        "target": "properties"
    }],
    "responseData": {
        "listingAssets": {
            "language": "en-us",
            "storeLogos":[{
                "id": "1234567890abcdefgh",
                "primaryAssetUploadUrl": "https://contoso.com/upload?blob=1234567890abcdefgh&sig=12345",
                "secondaryAssetUploadUrl": "https://contoso.com/upload?blob=0987654321abcdfger&sig=54326",
                "httpMethod": "PUT",
                "httpHeaders": {"Required Header Name": "Header Value"}
            }],
            "screenshots":[{
                "id": "0987654321abcdfger",
                "primaryAssetUploadUrl": "https://contoso.com/upload?blob=0987654321abcdfger&sig=54321",
                "secondaryAssetUploadUrl": "https://contoso.com/upload?blob=0987654321abcdfger&sig=54322",
                "httpMethod": "PUT",
                "httpHeaders": {"Required Header Name": "Header Value"}

            }]
        }
    } 
}

Api voor het doorvoeren van assets

Hiermee wordt de nieuwe vermeldingsonderdeel doorgevoerd die is geüpload met behulp van de details van de Creëer Assets API binnen de huidige conceptinzending.

Pad: /submission/v1/product/{productId}/listings/assets/commit
Methode : PUT

padparameters

vereiste headers

Verzoekparameters

Voorbeeldaanvraag

{
    "listingAssets": { 
        "language": "en-us",    
        "storeLogos": [
            {
                "id": "1234567890abcdefgh",
                "assetUrl": "https://contoso.com/blob=1234567890abcdefgh",
            }
        ],
        "screenshots": [
            {
                "id": "1234567891abcdefgh",
                "assetUrl": "https://contoso.com/blob=1234567891abcdefgh",
            }
        ]
    }
}

Antwoordheaders

antwoordparameters

voorbeeldantwoord

{
    "isSuccess": true,
    "errors": [{
        "code": "badrequest",
        "message": "Error Message 1",
        "target": "listings"
        }, {
        "code": "warning",
        "message": "Warning Message 1",
        "target": "properties"
    }],
    "responseData": {
        "pollingUrl": "/submission/v1/product/{productId}/submission/{submissionId}/status",
        "ongoingSubmissionId": ""
    } 
}

API voor module-statuspeiling

API om de gereedheid van de module te controleren voordat verzending kan worden gemaakt. Valideert ook de uploadstatus van het pakket.

Pad: /submission/v1/product/{productId}/status
Methode : GET

padparameters

vereiste headers

Antwoordheaders

antwoordparameters

voorbeeldantwoord

{
    "isSuccess": true,
    "errors": [{
        "code": "badrequest",
        "message": "Error Message 1",
        "target": "listings"
        }, {
        "code": "warning",
        "message": "Warning Message 1",
        "target": "properties"
    }],
    "responseData": {
        "isReady": true,
        "ongoingSubmissionId": ""
    }
}

Indienings-API maken

Hiermee maakt u een inzending op basis van het huidige concept voor MSI- of EXE-app. De API controleert:

• voor actieve inzending en mislukt met een foutbericht als er een actieve inzending bestaat.
• als alle modules in gereed status zijn om een indiening te doen.
• elk veld in de inzending wordt gevalideerd volgens de vereisten van de Store

Pad:/submission/v1/product/{productId}/submit
methode: POST

padparameters

vereiste headers

Antwoordheaders

antwoordparameters

voorbeeldantwoord

{
    "isSuccess": true,
    "errors": [{
        "code": "badrequest",
        "message": "Error Message 1",
        "target": "listings"
        }, {
        "code": "warning",
        "message": "Warning Message 1",
        "target": "properties"
    }],
    "responseData": {
        "submissionId": "1234567890", 
        "pollingUrl": "/submission/v1/product/{productId}/submission/{submissionId}/status",
        "ongoingSubmissionId": ""
    }
}

API voor het peilen van indieningsstatus

API om de status van de inzending te controleren.

Pad: /submission/v1/product/{productId}/submission/{submissionId}/status
Methode : GET

padparameters

vereiste headers

Antwoordheaders

antwoordparameters

voorbeeldantwoord

{
    "isSuccess": true,
    "errors": [{
        "code": "badrequest",
        "message": "Error Message 1",
        "target": "listings"
        }, {
        "code": "warning",
        "message": "Warning Message 1",
        "target": "properties"
    }],
    "responseData": {
        "publishingStatus": "INPROGRESS",
        "hasFailed": false
    }
}

Codevoorbeelden

De volgende artikelen bevatten gedetailleerde codevoorbeelden die laten zien hoe u de Microsoft Store-inzendings-API in verschillende programmeertalen kunt gebruiken:

C#-voorbeeld: Microsoft Store-indienings-API voor MSI- of EXE-app

Dit artikel bevat voorbeelden van C#-code die laten zien hoe u de Microsoft Store-inzendings-API voor MSI- of EXE-app gebruikt. U kunt elk voorbeeld bekijken voor meer informatie over de taak die wordt gedemonstreert, of u kunt alle codevoorbeelden in dit artikel bouwen in een consoletoepassing.

Voorwaarden In deze voorbeelden wordt de volgende bibliotheek gebruikt:

• Newtonsoft.Json NuGet-pakket van Newtonsoft.

Hoofdprogramma In het volgende voorbeeld wordt een opdrachtregelprogramma geïmplementeerd dat de andere voorbeeldmethoden in dit artikel aanroept om verschillende manieren te demonstreren om de Microsoft Store-indienings-API te gebruiken. Dit programma aanpassen voor uw eigen gebruik:

• Wijs de eigenschap SellerId toe aan de verkoper-id van uw Partnercentrum-account.
• Wijs de eigenschap ApplicationId toe aan de id van de app die u wilt beheren.
• Wijs de eigenschappen ClientId en ClientSecret toe aan de client-id en -sleutel voor uw app en vervang de tenantid-tekenreeks in de TokenEndpoint-URL door de tenant-id voor uw app. Zie Een Microsoft Entra ID-toepassing koppelen aan uw Partnercentrum-account voor meer informatie

using System;
using System.Threading.Tasks;

namespace Win32SubmissionApiCSharpSample
{
    public class Program
    {
        static async Task Main(string[] args)
        {
            var config = new ClientConfiguration()
            {
                ApplicationId = "...",
                ClientId = "...",
                ClientSecret = "...",
                Scope = "https://api.store.microsoft.com/.default",
                ServiceUrl = "https://api.store.microsoft.com",
                TokenEndpoint = "...",
                SellerId = 0
            };

            await new AppSubmissionUpdateSample(config).RunAppSubmissionUpdateSample();

        }
    }
}

Helperklasse voor ClientConfiguration met C#

De voorbeeld-app maakt gebruik van de helperklasse ClientConfiguration om Microsoft Entra ID Directory-gegevens en app-gegevens door te geven aan elk van de voorbeeldmethoden die gebruikmaken van de Microsoft Store-inzendings-API.

using System;
using System.Collections.Generic;
using System.Text;

namespace Win32SubmissionApiCSharpSample
{
    public class ClientConfiguration
    {
        /// <summary>
        /// Client Id of your Microsoft Entra ID Directory app.
        /// Example" 00001111-aaaa-2222-bbbb-3333cccc4444
        /// </summary>
        public string ClientId { get; set; }

        /// <summary>
        /// Client secret of your Microsoft Entra ID Directory app
        /// </summary>
        public string ClientSecret { get; set; }

        /// <summary>
        /// Service root endpoint.
        /// Example: "https://api.store.microsoft.com"
        /// </summary>
        public string ServiceUrl { get; set; }

        /// <summary>
        /// Token endpoint to which the request is to be made. Specific to your Microsoft Entra ID Directory app
        /// Example: https://login.microsoftonline.com/d454d300-128e-2d81-334a-27d9b2baf002/oauth2/v2.0/token
        /// </summary>
        public string TokenEndpoint { get; set; }

        /// <summary>
        /// Resource scope. If not provided (set to null), default one is used for the production API
        /// endpoint ("https://api.store.microsoft.com/.default")
        /// </summary>
        public string Scope { get; set; }

        /// <summary>
        /// Partner Center Application ID.
        /// Example: 3e31a9f9-84e8-4d2d-9eba-487878d02ebf
        /// </summary>
        public string ApplicationId { get; set; }


        /// <summary>
        /// The Partner Center Seller Id
        /// Example: 123456892
        /// </summary>
        public int SellerId { get; set; }
    }
}

Een app-inzending maken met C#

In het volgende voorbeeld wordt een klasse geïmplementeerd die gebruikmaakt van verschillende methoden in de Microsoft Store-indienings-API om een app-inzending bij te werken.

using Newtonsoft.Json.Linq;
using System;
using System.Collections.Generic;
using System.IO;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

namespace Win32SubmissionApiCSharpSample
{
    public class AppSubmissionUpdateSample
    {
        private ClientConfiguration ClientConfig;

        /// <summary>
        /// Constructor
        /// </summary>
        /// <param name="configuration">An instance of ClientConfiguration that contains all parameters populated</param>
        public AppSubmissionUpdateSample(ClientConfiguration configuration)
        {
            this.ClientConfig = configuration;
        }

        /// <summary>
        /// Main method to Run the Sample Application
        /// </summary>
        /// <returns></returns>
        /// <exception cref="InvalidOperationException"></exception>
        public async Task RunAppSubmissionUpdateSample()
        {
            // **********************
            //       SETTINGS
            // **********************
            var appId = this.ClientConfig.ApplicationId;
            var clientId = this.ClientConfig.ClientId;
            var clientSecret = this.ClientConfig.ClientSecret;
            var serviceEndpoint = this.ClientConfig.ServiceUrl;
            var tokenEndpoint = this.ClientConfig.TokenEndpoint;
            var scope = this.ClientConfig.Scope;

            // Get authorization token.
            Console.WriteLine("Getting authorization token");
            var accessToken = await SubmissionClient.GetClientCredentialAccessToken(
                tokenEndpoint,
                clientId,
                clientSecret,
                scope);

            var client = new SubmissionClient(accessToken, serviceEndpoint);

            client.DefaultHeaders = new Dictionary<string, string>()
            {
                {"X-Seller-Account-Id", this.ClientConfig.SellerId.ToString() }
            };

            Console.WriteLine("Getting Current Application Draft Status");
            
            dynamic AppDraftStatus = await client.Invoke<dynamic>(HttpMethod.Get, string.Format(SubmissionClient.ProductDraftStatusPollingUrlTemplate,
                SubmissionClient.Version, appId), null);
            
            Console.WriteLine(AppDraftStatus.ToString());

            Console.WriteLine("Getting Application Packages ");

            dynamic PackagesResponse = await client.Invoke<dynamic>(HttpMethod.Get, string.Format(SubmissionClient.PackagesUrlTemplate,
                SubmissionClient.Version, appId), null);

            Console.WriteLine(PackagesResponse.ToString());

            Console.WriteLine("Getting Single Package");

            dynamic SinglePackageResponse = await client.Invoke<dynamic>(HttpMethod.Get, string.Format(SubmissionClient.PackageByIdUrlTemplate,
                SubmissionClient.Version, appId, (string)PackagesResponse.responseData.packages[0].packageId), null);

            Console.WriteLine(SinglePackageResponse.ToString());

            Console.WriteLine("Updating Entire Package Set");

            // Update data in Packages list to have final set of updated Packages

            // Example - Updating Installer Parameters
            PackagesResponse.responseData.packages[0].installerParameters = "/s /r new-args";

            dynamic PackagesUpdateRequest = new
            {
                packages = PackagesResponse.responseData.packages
            };

            dynamic PackagesUpdateResponse = await client.Invoke<dynamic>(HttpMethod.Put, string.Format(SubmissionClient.PackagesUrlTemplate,
                SubmissionClient.Version, appId), PackagesUpdateRequest);

            Console.WriteLine(PackagesUpdateResponse.ToString());

            Console.WriteLine("Updating Single Package's Download Url");

            // Update data in the SinglePackage object

            var SinglePackageUpdateRequest = SinglePackageResponse.responseData.packages[0];

            // Example - Updating Installer Parameters
            SinglePackageUpdateRequest.installerParameters = "/s /r /t new-args";

            dynamic PackageUpdateResponse = await client.Invoke<dynamic>(HttpMethod.Patch, string.Format(SubmissionClient.PackageByIdUrlTemplate,
                SubmissionClient.Version, appId, SinglePackageUpdateRequest.packageId), SinglePackageUpdateRequest);

            Console.WriteLine("Committing Packages");

            dynamic PackageCommitResponse = await client.Invoke<dynamic>(HttpMethod.Post, string.Format(SubmissionClient.PackagesCommitUrlTemplate,
                SubmissionClient.Version, appId), null);

            Console.WriteLine(PackageCommitResponse.ToString());

            Console.WriteLine("Polling Package Upload Status");

            AppDraftStatus = await client.Invoke<dynamic>(HttpMethod.Get, string.Format(SubmissionClient.ProductDraftStatusPollingUrlTemplate,
                SubmissionClient.Version, appId), null);

            while (!((bool)AppDraftStatus.responseData.isReady))
            {
                AppDraftStatus = await client.Invoke<dynamic>(HttpMethod.Get, string.Format(SubmissionClient.ProductDraftStatusPollingUrlTemplate,
                    SubmissionClient.Version, appId), null);

                Console.WriteLine("Waiting for Upload to finish");

                await Task.Delay(TimeSpan.FromSeconds(2));

                if(AppDraftStatus.errors != null && AppDraftStatus.errors.Count > 0)
                {
                    for(var index = 0; index < AppDraftStatus.errors.Count; index++)
                    {
                        if(AppDraftStatus.errors[index].code == "packageuploaderror")
                        {
                            throw new InvalidOperationException("Package Upload Failed. Please try committing packages again.");
                        }
                    }
                }
            }

            Console.WriteLine("Getting Application Metadata - All Modules");

            dynamic AppMetadata = await client.Invoke<dynamic>(HttpMethod.Get, string.Format(SubmissionClient.AppMetadataUrlTemplate,
                SubmissionClient.Version, appId), null);

            Console.WriteLine(AppMetadata.ToString());

            Console.WriteLine("Getting Application Metadata - Listings");

            dynamic AppListingsMetadata = await client.Invoke<dynamic>(HttpMethod.Get, string.Format(SubmissionClient.AppListingsFetchMetadataUrlTemplate,
                SubmissionClient.Version, appId), null);

            Console.WriteLine(AppListingsMetadata.ToString());

            Console.WriteLine("Updating Listings Metadata - Description");

            // Update Required Fields in Listings Metadata Object - Per Language. For eg. AppListingsMetadata.responseData.listings[0]

            // Example - Updating Description
            AppListingsMetadata.responseData.listings[0].description = "New Description Updated By C# Sample Code";

            dynamic ListingsUpdateRequest = new
            {
                listings = AppListingsMetadata.responseData.listings[0]
            };

            dynamic UpdateListingsMetadataResponse = await client.Invoke<dynamic>(HttpMethod.Put, string.Format(SubmissionClient.AppMetadataUrlTemplate,
                SubmissionClient.Version, appId), ListingsUpdateRequest);

            Console.WriteLine(UpdateListingsMetadataResponse.ToString());

            Console.WriteLine("Getting All Listings Assets");

            dynamic ListingAssets = await client.Invoke<dynamic>(HttpMethod.Get, string.Format(SubmissionClient.ListingAssetsUrlTemplate,
                SubmissionClient.Version, appId), null);

            Console.WriteLine(ListingAssets.ToString());

            Console.WriteLine("Creating Listing Assets for 1 Screenshot");

            
            dynamic AssetCreateRequest = new
            {
                language = ListingAssets.responseData.listingAssets[0].language,
                createAssetRequest = new Dictionary<string, int>()
                {
                    {"Screenshot", 1 },
                    {"Logo", 0 }
                }
            };

            dynamic AssetCreateResponse = await client.Invoke<dynamic>(HttpMethod.Post, string.Format(SubmissionClient.ListingAssetsCreateUrlTemplate,
               SubmissionClient.Version, appId), AssetCreateRequest);

            Console.WriteLine(AssetCreateResponse.ToString());

            Console.WriteLine("Uploading Listing Assets");

            // Path to PNG File to be Uploaded as Screenshot / Logo
            var PathToFile = "./Image.png";
            var AssetToUpload = File.OpenRead(PathToFile);

            await client.UploadAsset(AssetCreateResponse.responseData.listingAssets.screenshots[0].primaryAssetUploadUrl.Value as string, AssetToUpload);

            Console.WriteLine("Committing Listing Assets");

            dynamic AssetCommitRequest = new
            {
                listingAssets = new
                {
                    language = ListingAssets.responseData.listingAssets[0].language,
                    storeLogos = ListingAssets.responseData.listingAssets[0].storeLogos,
                    screenshots = JToken.FromObject(new List<dynamic>() { new
                {
                    id = AssetCreateResponse.responseData.listingAssets.screenshots[0].id.Value as string,
                    assetUrl = AssetCreateResponse.responseData.listingAssets.screenshots[0].primaryAssetUploadUrl.Value as string
                }
                }.ToArray())
                }
            };

            dynamic AssetCommitResponse = await client.Invoke<dynamic>(HttpMethod.Put, string.Format(SubmissionClient.ListingAssetsCommitUrlTemplate,
               SubmissionClient.Version, appId), AssetCommitRequest);

            Console.WriteLine(AssetCommitResponse.ToString());

            Console.WriteLine("Getting Current Application Draft Status before Submission");

            AppDraftStatus = await client.Invoke<dynamic>(HttpMethod.Get, string.Format(SubmissionClient.ProductDraftStatusPollingUrlTemplate,
                SubmissionClient.Version, appId), null);

            Console.WriteLine(AppDraftStatus.ToString());

            if (AppDraftStatus == null || !((bool)AppDraftStatus.responseData.isReady))
            {
                throw new InvalidOperationException("Application Current Status is not in Ready Status for All Modules");
            }

            Console.WriteLine("Creating Submission");

            dynamic SubmissionCreationResponse = await client.Invoke<dynamic>(HttpMethod.Post, string.Format(SubmissionClient.CreateSubmissionUrlTemplate,
                SubmissionClient.Version, appId), null);

            Console.WriteLine(SubmissionCreationResponse.ToString());

            Console.WriteLine("Current Submission Status");

            dynamic SubmissionStatus = await client.Invoke<dynamic>(HttpMethod.Get, string.Format(SubmissionClient.SubmissionStatusPollingUrlTemplate,
                SubmissionClient.Version, appId, SubmissionCreationResponse.responseData.submissionId.Value as string), null);

            Console.Write(SubmissionStatus.ToString());

            // User can Poll on this API to know if Submission Status is INPROGRESS, PUBLISHED or FAILED.
            // This Process involves File Scanning, App Certification and Publishing and can take more than a day.
        }
    }
}

Helperklasse van IngestionClient met behulp van C#

De klasse IngestionClient biedt helpermethoden die worden gebruikt door andere methoden in de voorbeeld-app om de volgende taken uit te voeren:

• Haal een Microsoft Entra ID-toegangstoken op dat kan worden gebruikt om methoden aan te roepen in de Microsoft Store-inzendings-API. Nadat u een token hebt verkregen, hebt u 60 minuten de tijd om dit token te gebruiken in aanroepen naar de Microsoft Store-inzendings-API voordat het token verloopt. Nadat het token is verlopen, kunt u een nieuw token genereren.
• De HTTP-aanvragen voor de Microsoft Store-inzendings-API verwerken.

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;
using System.Collections.Generic;
using System.IO;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;

namespace Win32SubmissionApiCSharpSample
{
    /// <summary>
    /// This class is a proxy that abstracts the functionality of the API service
    /// </summary>
    public class SubmissionClient : IDisposable
    {
        public static readonly string Version = "1";
        private HttpClient httpClient;
        private HttpClient imageUploadClient;

        private readonly string accessToken;

        public static readonly string PackagesUrlTemplate = "/submission/v{0}/product/{1}/packages";
        public static readonly string PackageByIdUrlTemplate = "/submission/v{0}/product/{1}/packages/{2}";
        public static readonly string PackagesCommitUrlTemplate = "/submission/v{0}/product/{1}/packages/commit";
        public static readonly string AppMetadataUrlTemplate = "/submission/v{0}/product/{1}/metadata";
        public static readonly string AppListingsFetchMetadataUrlTemplate = "/submission/v{0}/product/{1}/metadata/listings";
        public static readonly string ListingAssetsUrlTemplate = "/submission/v{0}/product/{1}/listings/assets";
        public static readonly string ListingAssetsCreateUrlTemplate = "/submission/v{0}/product/{1}/listings/assets/create";
        public static readonly string ListingAssetsCommitUrlTemplate = "/submission/v{0}/product/{1}/listings/assets/commit";
        public static readonly string ProductDraftStatusPollingUrlTemplate = "/submission/v{0}/product/{1}/status";
        public static readonly string CreateSubmissionUrlTemplate = "/submission/v{0}/product/{1}/submit";
        public static readonly string SubmissionStatusPollingUrlTemplate = "/submission/v{0}/product/{1}/submission/{2}/status";

        public const string JsonContentType = "application/json";
        public const string PngContentType = "image/png";
        public const string BinaryStreamContentType = "application/octet-stream";

        /// <summary>
        /// Initializes a new instance of the <see cref="SubmissionClient" /> class.
        /// </summary>
        /// <param name="accessToken">
        /// The access token. This is JWT a token obtained from Microsoft Entra ID Directory allowing the caller to invoke the API
        /// on behalf of a user
        /// </param>
        /// <param name="serviceUrl">The service URL.</param>
        public SubmissionClient(string accessToken, string serviceUrl)
        {
            if (string.IsNullOrEmpty(accessToken))
            {
                throw new ArgumentNullException("accessToken");
            }

            if (string.IsNullOrEmpty(serviceUrl))
            {
                throw new ArgumentNullException("serviceUrl");
            }

            this.accessToken = accessToken;
            this.httpClient = new HttpClient
            {
                BaseAddress = new Uri(serviceUrl)
            };
            this.imageUploadClient = new HttpClient();
            this.DefaultHeaders = new Dictionary<string, string>();
        }

        /// <summary>
        /// Gets or Sets the default headers.
        /// </summary>
        public Dictionary<string, string> DefaultHeaders { get; set; }

        /// <summary>
        /// Performs application-defined tasks associated with freeing, releasing, or resetting
        /// unmanaged resources.
        /// </summary>
        public void Dispose()
        {
            if (this.httpClient != null)
            {
                this.httpClient.Dispose();
                this.httpClient = null;
                GC.SuppressFinalize(this);
            }
        }

        /// <summary>
        /// Gets the authorization token for the provided client id, client secret, and the scope.
        /// This token is usually valid for 1 hour, so if your submission takes longer than that to complete,
        /// make sure to get a new one periodically.
        /// </summary>
        /// <param name="tokenEndpoint">Token endpoint to which the request is to be made. Specific to your
        /// Microsoft Entra ID Directory app. Example: https://login.microsoftonline.com/d454d300-128e-2d81-334a-27d9b2baf002/oauth2/v2.0/token </param>
        /// <param name="clientId">Client Id of your Microsoft Entra ID Directory app. Example" 00001111-aaaa-2222-bbbb-3333cccc4444</param>
        /// <param name="clientSecret">Client secret of your Microsoft Entra ID Directory app</param>
        /// <param name="scope">Scope. If not provided, default one is used for the production API endpoint.</param>
        /// <returns>Autorization token. Prepend it with "Bearer: " and pass it in the request header as the
        /// value for "Authorization: " header.</returns>
        public static async Task<string> GetClientCredentialAccessToken(
            string tokenEndpoint,
            string clientId,
            string clientSecret,
            string scope = null)
        {
            if (scope == null)
            {
                scope = "https://api.store.microsoft.com/.default";
            }

            dynamic result;
            using (HttpClient client = new HttpClient())
            {
                string tokenUrl = tokenEndpoint;
                using (
                    HttpRequestMessage request = new HttpRequestMessage(
                        HttpMethod.Post,
                        tokenUrl))
                {
                    string strContent =
                        string.Format(
                            "grant_type=client_credentials&client_id={0}&client_secret={1}&scope={2}",
                            clientId,
                            clientSecret,
                            scope);

                    request.Content = new StringContent(strContent, Encoding.UTF8,
                        "application/x-www-form-urlencoded");

                    using (HttpResponseMessage response = await client.SendAsync(request))
                    {
                        string responseContent = await response.Content.ReadAsStringAsync();
                        result = JsonConvert.DeserializeObject(responseContent);
                    }
                }
            }

            return result.access_token;
        }


        /// <summary>
        /// Invokes the specified HTTP method.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="httpMethod">The HTTP method.</param>
        /// <param name="relativeUrl">The relative URL.</param>
        /// <param name="requestContent">Content of the request.</param>
        /// <returns>instance of the type T</returns>
        /// <exception cref="ServiceException"></exception>
        public async Task<T> Invoke<T>(HttpMethod httpMethod,
            string relativeUrl,
            object requestContent)
        {
            using (var request = new HttpRequestMessage(httpMethod, relativeUrl))
            {
                this.SetRequest(request, requestContent);

                using (HttpResponseMessage response = await this.httpClient.SendAsync(request))
                {
                    T result;
                    if (this.TryHandleResponse(response, out result))
                    {
                        return result;
                    }

                    if (response.IsSuccessStatusCode)
                    {
                        var resource = JsonConvert.DeserializeObject<T>(await response.Content.ReadAsStringAsync());
                        return resource;
                    }

                    throw new Exception(await response.Content.ReadAsStringAsync());
                }
            }
        }

        /// <summary>
        /// Uploads a given Image Asset file to Asset Storage
        /// </summary>
        /// <param name="assetUploadUrl">Asset Storage Url</param>
        /// <param name="fileStream">The Stream instance of file to be uploaded</param>
        /// <returns></returns>
        /// <exception cref="Exception"></exception>
        public async Task UploadAsset(string assetUploadUrl, Stream fileStream)
        {
            using (var request = new HttpRequestMessage(HttpMethod.Put, assetUploadUrl))
            {
                request.Headers.Add("x-ms-blob-type", "BlockBlob");
                request.Content = new StreamContent(fileStream);
                request.Content.Headers.ContentType = new MediaTypeHeaderValue(PngContentType);
                using (HttpResponseMessage response = await this.imageUploadClient.SendAsync(request))
                {
                    if (response.IsSuccessStatusCode)
                    {
                        return;
                    }
                    throw new Exception(await response.Content.ReadAsStringAsync());
                }
            }
        }

        /// <summary>
        /// Sets the request.
        /// </summary>
        /// <param name="request">The request.</param>
        /// <param name="requestContent">Content of the request.</param>
        protected virtual void SetRequest(HttpRequestMessage request, object requestContent)
        {
            request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", this.accessToken);

            foreach (var header in this.DefaultHeaders)
            {
                request.Headers.Add(header.Key, header.Value);
            }

            if (requestContent != null)
            {
                request.Content = new StringContent(JsonConvert.SerializeObject(requestContent),
                        Encoding.UTF8,
                        JsonContentType);
                
            }
        }


        /// <summary>
        /// Tries the handle response.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="response">The response.</param>
        /// <param name="result">The result.</param>
        /// <returns>true if the response was handled</returns>
        protected virtual bool TryHandleResponse<T>(HttpResponseMessage response, out T result)
        {
            result = default(T);
            return false;
        }
    }
}

Node.js voorbeeld: Microsoft Store-indienings-API voor MSI- of EXE-app

Dit artikel bevat Node.js codevoorbeelden die laten zien hoe u de Microsoft Store-inzendings-API voor MSI- of EXE-app gebruikt. U kunt elk voorbeeld bekijken voor meer informatie over de taak die wordt gedemonstreert, of u kunt alle codevoorbeelden in dit artikel bouwen in een consoletoepassing.

Voorwaarden In deze voorbeelden wordt de volgende bibliotheek gebruikt:

• node-fetch v2 [gebruik de volgende opdracht: npm install node-fetch@2]

Een app-inzending maken met behulp van node.js

In het volgende voorbeeld worden de andere voorbeeldmethoden in dit artikel aangeroepen om verschillende manieren te demonstreren om de Microsoft Store-inzendings-API te gebruiken. Dit programma aanpassen voor uw eigen gebruik:

• Wijs de eigenschap SellerId toe aan de verkoper-id van uw Partnercentrum-account.
• Wijs de eigenschap ApplicationId toe aan de id van de app die u wilt beheren.
• Wijs de eigenschappen ClientId en ClientSecret toe aan de client-id en -sleutel voor uw app en vervang de tenantid-tekenreeks in de TokenEndpoint-URL door de tenant-id voor uw app. Zie Een Microsoft Entra ID-toepassing koppelen aan uw Partnercentrum-account voor meer informatie

In het volgende voorbeeld wordt een klasse geïmplementeerd die gebruikmaakt van verschillende methoden in de Microsoft Store-indienings-API om een app-inzending bij te werken.

const config = require('./Configuration');
const submissionClient = require('./SubmissionClient');
const fs = require('fs');

var client = new submissionClient(config);

/**
 * Main entry method to Run the Store Submission API Node.js Sample
 */
async function RunNodeJsSample(){
    print('Getting Access Token');
    await client.getAccessToken();
    
    print('Getting Current Application Draft Status');
    var currentDraftStatus = await client.callStoreAPI(client.productDraftStatusPollingUrlTemplate, 'get');
    print(currentDraftStatus);

    print('Getting Application Packages');
    var currentPackages = await client.callStoreAPI(client.packagesUrlTemplate, 'get');
    print(currentPackages);

    print('Getting Single Package');
    var packageId = currentPackages.responseData.packages[0].packageId;
    var packageIdUrl = `${client.packageByIdUrlTemplate}`.replace('{packageId}', packageId);
    var singlePackage = await client.callStoreAPI(packageIdUrl, 'get');
    print(singlePackage);

    print('Updating Entire Package Set');
    // Update data in Packages list to have final set of updated Packages
    currentPackages.responseData.packages[0].installerParameters = "/s /r new-args";
    var packagesUpdateRequest = {
        'packages': currentPackages.responseData.packages
    };
    print(packagesUpdateRequest);
    var packagesUpdateResponse = await client.callStoreAPI(client.packagesUrlTemplate, 'put', packagesUpdateRequest);
    print(packagesUpdateResponse);

    print('Updating Single Package\'s Download Url');
    // Update data in the SinglePackage object
    singlePackage.responseData.packages[0].installerParameters = "/s /r /t new-args";
    var singlePackageUpdateResponse = await client.callStoreAPI(packageIdUrl, 'patch', singlePackage.responseData.packages[0]);
    print(singlePackageUpdateResponse);

    print('Committing Packages');
    var commitPackagesResponse = await client.callStoreAPI(client.packagesCommitUrlTemplate, 'post');
    print(commitPackagesResponse);

    await poll(async ()=>{
        print('Waiting for Upload to finish');
        return await client.callStoreAPI(client.productDraftStatusPollingUrlTemplate, 'get');
    }, 2);

    print('Getting Application Metadata - All Modules');
    var appMetadata = await client.callStoreAPI(client.appMetadataUrlTemplate, 'get');
    print(appMetadata);

    print('Getting Application Metadata - Listings');
    var appListingMetadata = await client.callStoreAPI(client.appListingsFetchMetadataUrlTemplate, 'get');
    print(appListingMetadata);

    print('Updating Listings Metadata - Description');   
    // Update Required Fields in Listings Metadata Object - Per Language. For eg. AppListingsMetadata.responseData.listings[0]
    // Example - Updating Description
    appListingMetadata.responseData.listings[0].description = 'New Description Updated By Node.js Sample Code';
    var listingsUpdateRequest = {
        'listings': appListingMetadata.responseData.listings[0]
    };
    var listingsMetadataUpdateResponse = await client.callStoreAPI(client.appMetadataUrlTemplate, 'put', listingsUpdateRequest);
    print(listingsMetadataUpdateResponse);

    print('Getting All Listings Assets');
    var listingAssets = await client.callStoreAPI(client.listingAssetsUrlTemplate, 'get');
    print(listingAssets);

    print('Creating Listing Assets for 1 Screenshot');
    var listingAssetCreateRequest = {
        'language': listingAssets.responseData.listingAssets[0].language,
        'createAssetRequest': {
            'Screenshot': 1,
            'Logo': 0
        }
    };
    var listingAssetCreateResponse = await client.callStoreAPI(client.listingAssetsCreateUrlTemplate, 'post', listingAssetCreateRequest);
    print(listingAssetCreateResponse);

    print('Uploading Listing Assets');
    const pathToFile = './Image.png';
    const stats = fs.statSync(pathToFile);
    const fileSize = stats.size;
    const fileStream = fs.createReadStream(pathToFile);
    await client.uploadAssets(listingAssetCreateResponse.responseData.listingAssets.screenshots[0].primaryAssetUploadUrl, fileStream, fileSize);

    print('Committing Listing Assets');
    var assetCommitRequest = {
        'listingAssets': {
            'language': listingAssets.responseData.listingAssets[0].language,
            'storeLogos': listingAssets.responseData.listingAssets[0].storeLogos,
            'screenshots': [{
                'id': listingAssetCreateResponse.responseData.listingAssets.screenshots[0].id,
                'assetUrl': listingAssetCreateResponse.responseData.listingAssets.screenshots[0].primaryAssetUploadUrl
            }]
        }
    };
    var assetCommitResponse = await client.callStoreAPI(client.listingAssetsCommitUrlTemplate, 'put', assetCommitRequest);
    print(assetCommitResponse);

    print('Getting Current Application Draft Status before Submission');
    currentDraftStatus = await client.callStoreAPI(client.productDraftStatusPollingUrlTemplate, 'get');
    print(currentDraftStatus);
    if(!currentDraftStatus.responseData.isReady){
        throw new Error('Application Current Status is not in Ready Status for All Modules');
    }

    print('Creating Submission');
    var submissionCreationResponse = await client.callStoreAPI(client.createSubmissionUrlTemplate, 'post');
    print(submissionCreationResponse);

    print('Current Submission Status');
    var submissionStatusUrl = `${client.submissionStatusPollingUrlTemplate}`.replace('{submissionId}', submissionCreationResponse.responseData.submissionId);
    var submissionStatusResponse = await client.callStoreAPI(submissionStatusUrl, 'get');
    print(submissionStatusResponse);

    // User can Poll on this API to know if Submission Status is INPROGRESS, PUBLISHED or FAILED.
    // This Process involves File Scanning, App Certification and Publishing and can take more than a day.
}

/**
 * Utility Method to Poll using a given function and time interval in seconds
 * @param {*} func 
 * @param {*} intervalInSeconds 
 * @returns 
 */
async function poll(func, intervalInSeconds){
var result = await func();
if(result.responseData.isReady){
    Promise.resolve(true);
}
else if(result.errors && result.errors.length > 0 && result.errors.find(element => element.code == 'packageuploaderror') != undefined){
throw new Error('Package Upload Failed');
}
else{
    await new Promise(resolve => setTimeout(resolve, intervalInSeconds*1000));
    return await poll(func, intervalInSeconds); 
}
}

/**
 * Utility function to Print a Json or normal string
 * @param {*} json 
 */
function print(json){
    if(typeof(json) == 'string'){
        console.log(json);
    }
    else{
        console.log(JSON.stringify(json));
    }
    console.log("\n");
}

/** Run the Node.js Sample Application */
RunNodeJsSample();

ClientConfiguration-hulpprogramma

De voorbeeld-app maakt gebruik van de helperklasse ClientConfiguration om Microsoft Entra ID Directory-gegevens en app-gegevens door te geven aan elk van de voorbeeldmethoden die gebruikmaken van de Microsoft Store-inzendings-API.

/** Configuration Object for Store Submission API */
var config = {
    version : "1",
    applicationId : "...",
    clientId : "...",
    clientSecret : "...",
    serviceEndpoint : "https://api.store.microsoft.com",
    tokenEndpoint : "...",
    scope : "https://api.store.microsoft.com/.default",
    sellerId : "...",
    jsonContentType : "application/json",
    pngContentType : "image/png",
    binaryStreamContentType : "application/octet-stream"
};

module.exports = config;

Helper van IngestionClient met behulp van node.js

De klasse IngestionClient biedt helpermethoden die worden gebruikt door andere methoden in de voorbeeld-app om de volgende taken uit te voeren:

• Haal een Microsoft Entra ID-toegangstoken op dat kan worden gebruikt om methoden aan te roepen in de Microsoft Store-inzendings-API. Nadat u een token hebt verkregen, hebt u 60 minuten de tijd om dit token te gebruiken in aanroepen naar de Microsoft Store-inzendings-API voordat het token verloopt. Nadat het token is verlopen, kunt u een nieuw token genereren.
• De HTTP-aanvragen voor de Microsoft Store-inzendings-API verwerken.

const fetch = require('node-fetch');
/**
 * Submission Client to invoke all available Store Submission API and Asset Upload to Blob Store
 */
class SubmissionClient{

    constructor(config){
        this.configuration = config;
        this.accessToken = "";
        this.packagesUrlTemplate = `/submission/v${this.configuration.version}/product/${this.configuration.applicationId}/packages`;
        this.packageByIdUrlTemplate = `/submission/v${this.configuration.version}/product/${this.configuration.applicationId}/packages/{packageId}`;
        this.packagesCommitUrlTemplate = `/submission/v${this.configuration.version}/product/${this.configuration.applicationId}/packages/commit`;
        this.appMetadataUrlTemplate = `/submission/v${this.configuration.version}/product/${this.configuration.applicationId}/metadata`;
        this.appListingsFetchMetadataUrlTemplate = `/submission/v${this.configuration.version}/product/${this.configuration.applicationId}/metadata/listings`;
        this.listingAssetsUrlTemplate = `/submission/v${this.configuration.version}/product/${this.configuration.applicationId}/listings/assets`;
        this.listingAssetsCreateUrlTemplate = `/submission/v${this.configuration.version}/product/${this.configuration.applicationId}/listings/assets/create`;
        this.listingAssetsCommitUrlTemplate = `/submission/v${this.configuration.version}/product/${this.configuration.applicationId}/listings/assets/commit`;
        this.productDraftStatusPollingUrlTemplate = `/submission/v${this.configuration.version}/product/${this.configuration.applicationId}/status`;
        this.createSubmissionUrlTemplate = `/submission/v${this.configuration.version}/product/${this.configuration.applicationId}/submit`;
        this.submissionStatusPollingUrlTemplate = `/submission/v${this.configuration.version}/product/${this.configuration.applicationId}/submission/{submissionId}/status`;
    }
    
    async getAccessToken(){
        var params = new URLSearchParams();
        params.append('grant_type','client_credentials');
        params.append('client_id',this.configuration.clientId);
        params.append('client_secret',this.configuration.clientSecret);
        params.append('scope',this.configuration.scope);
        var response = await fetch(this.configuration.tokenEndpoint,{
            method: "POST",
            body: params
        });    
        var data = await response.json();
        this.accessToken = data.access_token;
    }

    async callStoreAPI(url, method, data){
        var request = {
            method: method,
            headers:{
                'Authorization': `Bearer ${this.accessToken}`,
                'Content-Type': this.configuration.jsonContentType,
                'X-Seller-Account-Id': this.configuration.sellerId
            },            
        };
        if(data){
            request.body = JSON.stringify(data);
        }
        var response = await fetch(`${this.configuration.serviceEndpoint}${url}`,request);
        var jsonResponse = await response.json();
        return jsonResponse;
    }

    async uploadAssets(url, stream, size){
        var request = {
            method: 'put',
            headers:{
                'Content-Type': this.configuration.pngContentType,
                'x-ms-blob-type': 'BlockBlob',
                "Content-length": size
            },            
            body: stream
        };
        var response = await fetch(`${url}`,request);
        if(response.ok){
            return response;
        }
        else{
            throw new Error('Uploading of assets failed');
        }
    }
}
module.exports = SubmissionClient;

Aanvullende hulp

Als u vragen hebt over de Microsoft Store-inzendings-API of hulp nodig hebt bij het beheren van uw inzendingen met deze API, gebruikt u de volgende bronnen:

• Stel uw vragen op onze forums.
• Ga naar onze ondersteuningspagina en vraag een van de ondersteunde ondersteuningsopties voor partnercentrum aan. Als u wordt gevraagd een probleemtype en categorie te kiezen, kiest u respectievelijk App-inzending en certificering en Een app verzenden.

Veelgestelde vragen

1. Wat kan ik doen via de Microsoft Store indienings-API?

   Met de Microsoft Store-inzendings-API kunnen ontwikkelaars app-beheertaken automatiseren, waaronder:

   • Nieuwe app-updates maken en verzenden.
   • App-pakketten uploaden en beheren.
   • Metagegevens en Store-vermeldingen bijwerken.

   U kunt deze API integreren in uw continue integratie of werkstromen bouwen, routinetaken automatiseren om uw publicatieproces te stroomlijnen.