（舊版）預先授權 js-preauthorize

最後更新： 2026年8月19日

主題：
Authentication

NOTE

此頁面上的內容僅供參考。使用此API需要Adobe的目前授權。不允許未經授權的使用。

IMPORTANT

請務必隨時瞭解彙總在產品公告頁面中的最新Adobe Pass驗證產品公告和淘汰時間表。

概觀 preauth-overview

預先授權API方法可供應用程式用來取得一或多個資源的預先授權決定。預先授權API要求應該用於UI提示和/或內容篩選。在允許使用者存取指定的資源之前，必須先提出實際的授權API要求。

如果Adobe Pass驗證服務處理預先授權API請求時發生未預期的錯誤（例如網路問題，以及MVPD授權端點無法使用），則受影響資源的一或多個個別錯誤資訊將會作為「預先授權API」回應結果的一部分納入。

public preauthorize(request： PreauthorizeRequest， callback： AccessEnablerCallback<any>)： void preauth-method

描述：應用程式使用此方法，從Adobe Pass Authentication服務取得已驗證使用者的預先授權（資訊性）決定，以檢視特定的受保護資源，主要目的是裝飾應用程式的UI （例如，以鎖定和解鎖圖示來指示存取狀態）。

可用性： v4.4.0+

引數：

PreauthorizeRequest：用來定義要求的產生器物件
AccessEnablerCallback：用於傳回API回呼的回呼
PreauthorizeResponse：用來傳回API回應內容的物件

類別PreauthorizeRequestBuilder preath-req-builder-class

setResources(resources： string[])： PreauthorizeRequestBuilder set-res-preath-req-buildr

設定您要取得預先授權決定的資源清單。
您必須將其設定為使用預先授權API。
清單中的每個元素都必須是字串，代表必須與MVPD協定的資源ID值或媒體RSS片段。
這個方法只會在目前的PreauthorizeRequestBuilder物件執行個體的內容中設定資訊，這個物件執行個體是這個方法呼叫的接收者。
若要建置實際PreauthorizeRequest，您可以檢視PreauthorizeRequestBuilder的方法：

  build(): PreauthorizeRequest

@param {string[]}資源。您要取得預先授權決定的資源清單。
@returns {PreauthorizeRequestBuilder}相同PreauthorizeRequestBuilder物件執行個體的參考，這個物件執行個體是方法呼叫的接收者。
如此即可建立方法鏈結。

disableFeatures(…features： string[])： PreauthorizeRequestBuilder disabl-featres-preauth-req-buildr

設定您要在取得預先授權決定時停用這些功能的功能。
此函式只會在目前PreauthorizeRequestBuilder物件執行個體的內容中設定資訊，此物件執行個體是此函式呼叫的接收者。
若要建置實際PreauthorizeRequest，您可以檢視PreauthorizeRequestBuilder的函式：

public func build() -> PreauthorizeRequest

@param {string[]}功能。您想要停用它們的一組功能。
@returns同一PreauthorizeRequestBuilder物件執行個體（函式呼叫的接收者）的參考。
它這樣做是為了允許建立函式鏈結。

build()： PreauthorizeRequest preauth-req

建立和擷取新PreauthorizeRequest物件執行個體的參考。
此方法會在每次呼叫時將新的PreauthorizeRequest物件具現化。
此方法會使用目前PreauthorizeRequestBuilder物件執行個體（此方法呼叫的接收者）內容中預先設定的值。
請記住，此方法不會產生任何副作用，
因此，它不會變更SDK的狀態或PreauthorizeRequestBuilder物件執行個體的狀態，此物件執行個體是此方法呼叫的接收者。
這表示對相同接收器的這個方法後續呼叫將建立不同的新PreauthorizeRequest物件執行個體，但若值設定為PreauthorizeRequestBuilder，且未在呼叫之間修改，則具有相同的資訊。
如果您不需要更新任何提供的資訊（資源與快取），您可以針對預先授權API的多重用途重複使用PreauthorizeRequest執行個體。
@returns {PreauthorizeRequest}

介面AccessEnablerCallback<T> interface-access-enablr-callback

onResponse(result： T)； on-response-result

完成預先授權API要求時，SDK呼叫的回應回呼。
結果為成功或包含狀態的錯誤結果。
@param {T} result

onFailure（結果： T）； on-failure-result

當無法服務預先授權API請求時，SDK呼叫的失敗回呼。
結果會產生包含狀態的失敗結果。
@param {T} result

類別PreauthorizeResponse preauth-response-class

公開狀態：狀態； public-status

傳回：發生失敗時的其他狀態（狀態）資訊。
可能保留null值。

公開決定：決定[]； public-decisions

傳回：預先授權決定的清單。每個資源一個決策。
如果失敗，清單可能會是空的。

類別狀態 class-status

公開狀態：數字； public-status-numbr

RFC 7231中記錄的HTTP回應狀態代碼。
如果Status來自SDK而非Adobe Pass驗證服務，則可能是0。

公用代碼：號碼； public-code-numbr

標準Adobe Pass驗證服務錯誤代碼。
可能保留空字串或null值。

公開訊息：字串； public-msg-string

在某些情況下由MVPD授權端點或程式設計師降級規則提供的詳細訊息。
可能保留空字串或null值。

公開詳細資料：字串； public-details-strng

儲存詳細訊息，該訊息在某些情況下由MVPD授權端點或程式設計師降級規則提供。
可能保留空字串或null值。

public helpUrl： string； public-help-url-string

此URL會連結至關於為何發生此狀態/錯誤以及可能解決方案的詳細資訊。
可能保留空字串或null值。

公用追蹤：字串； public-trace-string

此回應的唯一識別碼，可在聯絡支援人員以識別更複雜案例中的特定問題時使用。
可能保留空字串或null值。

公開動作：字串； public-action-string

補救此情況的建議動作。
- 無：很遺憾，沒有預先定義的動作來修正此問題。這可能表示對公用API的呼叫不正確
- 組態：需要透過TVE儀表板或連絡支援人員來變更組態。
- application-registration：應用程式必須重新登入本身。
- 驗證：使用者必須驗證或重新驗證。
- 授權：使用者必須取得特定資源的授權。
- 退化：應該套用某種形式的退化。
- 重試：重試要求或許可以解決此問題
- 在指定時段後重試：在指定的時段後重試請求可能會解決問題。
可能保留空字串或null值。

類別決定 class-decision

公用識別碼：字串； public-id-string

取得決定的資源ID。

public authorized： boolean； public-auth-boolean

表示決策是否成功的旗標值。

公開錯誤：狀態； public-error-status

發生某些錯誤時的其他狀態（狀態）資訊。可能保留null值。

使用者端實作範例 client-imp-example

let accessEnablerApi = new window.AccessEnabler.AccessEnabler("software statement");
let accessEnablerModels = window.AccessEnabler.models;

// Build request
let requestBuilder = new accessEnablerModels.PreauthorizeRequest.getBuilder();
let request = requestBuilder
    .setResources(["RES01", "RES02", "RES03"])
    .disableFeatures("LOCAL_CACHE")
    .build();

// Create callback
let callback = {
    onResponse(response) {
        // Handle onResponse
    },
    onFailure(response) {
        // Handle onFailure
    }
};

// Invoke call
accessEnablerApi.preauthorize(request, callback);

案例範例 scenario-examples

案例1：已授權所有請求的資源 all-req-res-auth

案例2：已授權部分請求的資源。 sm-req-res-auth

增強的錯誤碼標幟

回應

已停用

code language-javascript
`{ "decisions": [ { "id": "RES01", "authorized": true }, { "id": "RES02", "authorized": true }, { "id": "RES03", "authorized": true } ] }`

案例3：沒有授權請求的資源。 none-req-res-auth

增強的錯誤碼標幟

回應

已停用

code language-javascript
`{ "decisions": [ { "id": "RES01", "authorized": true }, { "id": "RES02", "authorized": false }, { "id": "RES03", "authorized": true } ] }`

已啟用

code language-javascript

    {
      "decisions": [
        {
        "id": "RES01",
        "authorized": true
        },
        {
        "id": "RES02",
        "authorized": false,
        "error": {
            "status": 403,
            "code": "preauthorization_denied_by_mvpd",
            "message": "The MVPD has returned a \"Deny\" decision when requesting pre-authorization for the specified resource.",
            "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html?lang=zh-Hant",
            "action": "none"
        }
        },
        {
        "id": "RES03",
        "authorized": true
        },
    ]
    }

案例4：錯誤的使用者端請求 — 未指定資源。 bad-cl-req-no-res-sp

增強的錯誤碼標幟

回應

已停用

code language-javascript
`{ "decisions": [ { "id": "RES01", "authorized": false }, { "id": "RES02", "authorized": false }, { "id": "RES03", "authorized": false } ] }`

已啟用

code language-javascript

    {
    "decisions": [
        {
        "id": "RES01",
        "authorized": false,
        "error": {
            "status": 403,
            "code": "preauthorization_denied_by_mvpd",
            "message": "The MVPD has returned a \"Deny\" decision when requesting pre-authorization for the specified resource.",
            "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html?lang=zh-Hant",
            "action": "none"
            }
        },
        {
            "id": "RES02",
            "authorized": false,
            "error": {
                "status": 403,
                "code": "preauthorization_denied_by_mvpd",
                "message": "The MVPD has returned a \"Deny\" decision when requesting pre-authorization for the specified resource.",
                "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html?lang=zh-Hant",
                "action": "none"
            }
        },
        {
        "id": "RES03",
        "authorized": false,
        "error": {
            "status": 403,
            "code": "maximum_execution_time_exceeded",
            "message": "The request did not complete in the maximum allowed time. Retrying the request might solve the issue.",
            "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html?lang=zh-Hant",
            "action": "retry"
                }
            }
        ]
    }

增強的錯誤碼標幟

回應

已停用/已啟用

code language-javascript

    {
    "status": {
    "status": 400,
    "code": "internal_error",
    "message": "The request failed due to an internal error.",
    "details": "Required String[] parameter 'resource' is not present",
    "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html?lang=zh-Hant",
    "action": "none"
    },
    "decisions": []
    }

案例5：錯誤的使用者端請求 — 指定的資源是空的。 bad-cl-req-empt-res-sp

增強的錯誤碼標幟

回應

已停用/已啟用

code language-javascript

    {
    "status": {
    "status": 412,
    "code": "missing_resource",
    "message": "The resource parameter is missing",
    "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html?lang=zh-Hant",
    "action": "none"
    },
    "decisions": []
    }

案例6：網路錯誤。 ntwrk-error

增強的錯誤碼標幟

回應

已啟用

code language-javascript

    {
    "decisions": [
        {
        "id": "RES01",
        "authorized": false,
        "error": {
            "status": 403,
            "code": "network_received_error",
            "message": "There was a read error while retrieving the response from the associated partner service. Retrying the request might solve the issue.",
            "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html?lang=zh-Hant",
            "action": "retry"
            }
        },
        {
            "id": "RES02",
            "authorized": false,
            "error": {
                "status": 403,
                "code": "network_received_error",
                "message": "There was a read error while retrieving the response from the associated partner service. Retrying the request might solve the issue.",
                "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html?lang=zh-Hant",
                "action": "retry"
                }
        }
    ]
    }

案例7：叫用的預先授權流程沒有有效的AuthN工作階段。

增強的錯誤碼標幟

回應

已停用/已啟用

code language-javascript

    {
    "status": {
    "status": 0,
    "code": "authentication_session_missing",
    "message": "The authentication session associated with this request could not be retrieved. The user must re-authenticate with a supported MVPD in order to continue.",
    "action": "authentication"
    },
    "decisions": []
    }

案例8：在setRequestor呼叫完成之前叫用預先授權流程

增強的錯誤碼標幟

回應

已停用/已啟用

code language-javascript

    {
    "status": {
    "status": 0,
    "code": "requestor_not_configured",
    "message": "The requestor is not yet configured which is a prerequisite for using any API apart from the setRequestor API.",
    "action": "retry"
    },
    "decisions": []
    }

recommendation-more-help

pass-help-authentication