API 考慮

API 版本設定

注意

Cloud Partner 入口網站 API 已與整合，並將繼續在合作夥伴中心運作。 轉換引進了小型變更。 檢閱 Cloud Partner 入口網站 API 參考中所列的變更，以確保您的程式代碼在轉換至合作夥伴中心後繼續運作。 CPP API 應該只用於轉換至合作夥伴中心之前已整合的現有產品：新產品應使用合作夥伴中心提交 API。

可以同時提供多個版本的 API。 客戶端必須指出想要叫用哪個版本，方法是提供 api-version 參數做為查詢字串的一部分。

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

具有未知或無效 API 版本之要求的回應是 HTTP 程式代碼 400。 此錯誤會傳回回應主體中已知 API 版本的集合。

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

錯誤

API 會回應具有對應 HTTP 狀態代碼的錯誤，並選擇性地回應串行化為 JSON 的回應中的其他資訊。 當您收到錯誤，特別是 400 類別的錯誤時，在修正根本原因之前，請勿重試要求。 例如，在上述範例回應中，請先修正 API 版本參數，再重新傳送要求。

驗證頁首

對於此參考中的所有 API，您必須傳遞授權標頭以及從 Microsoft Entra ID 取得的持有人令牌。 需要此標頭才能接收有效的回應;如果不存在， 401 Unauthorized 則會傳回錯誤。

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

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>