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,您必須隨著從 Azure Active Directory (Azure AD) 取得的持有人權杖傳遞授權標頭。 需要此標頭才能接收有效的回應;若此標頭不存在,將會傳回 401 Unauthorized 錯誤。

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

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>