API-Überlegungen

API-Versionsverwaltung

Anmerkung

Die Cloud Partner Portal-APIs sind in Partner Center integriert und arbeiten weiterhin. Der Übergang führt zu kleinen Änderungen. Überprüfen Sie die in Cloud Partner Portal-API-Referenz aufgeführten Änderungen, um sicherzustellen, dass Ihr Code nach dem Übergang zum Partner Center weiterhin funktioniert. CPP-APIs sollten nur für vorhandene Produkte verwendet werden, die bereits vor dem Übergang zum Partner Center integriert wurden; neue Produkte sollten Partner Center-Übermittlungs-APIs verwenden.

Es kann mehrere Versionen der API geben, die gleichzeitig verfügbar sind. Clients müssen angeben, welche Version sie aufrufen möchten, indem sie den parameter api-version als Teil der Abfragezeichenfolge angeben.

GET https://cloudpartner.azure.com/api/offerTypes?api-version=2017-10-31

Die Antwort auf eine Anforderung mit einer unbekannten oder ungültigen API-Version ist ein HTTP-Code 400. Dieser Fehler gibt die Auflistung bekannter API-Versionen im Antworttext zurück.

    {
        "error": { 
            "code":"InvalidAPIVersion",
            "message":"Invalid api version. Allowed values are [2016-08-01-preview]"
        }
    }

Irrtümer

Die API reagiert auf Fehler mit den entsprechenden HTTP-Statuscodes und optional zusätzliche Informationen in der als JSON serialisierten Antwort. Wenn Sie einen Fehler erhalten, insbesondere ein Fehler der 400-Klasse, versuchen Sie die Anforderung nicht erneut, bevor Sie die zugrunde liegende Ursache beheben. Korrigieren Sie beispielsweise in der obigen Beispielantwort den API-Versionsparameter, bevor Sie die Anforderung erneut senden.

Autorisierungsheader

Für alle APIs in diesem Verweis müssen Sie den Autorisierungsheader zusammen mit dem Von Microsoft Entra-ID abgerufenen Bearertoken übergeben. Dieser Header ist erforderlich, um eine gültige Antwort zu erhalten; wenn nicht vorhanden, wird ein 401 Unauthorized Fehler zurückgegeben.

  GET https://cloudpartner.azure.com/api/offerTypes?api-version=2016-08-01-preview

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>