（舊版） JavaScript SDK逐步指南 javascript-sdk-cookbook
簡介 intro
本檔案說明程式設計師的上層應用程式為JavaScript與Adobe Pass驗證服務的整合所實作的權益工作流程。 JavaScript API參考資料連結包含在中。
另請注意，相關資訊區段包含
連結至一組JavaScript程式碼範例。
權益流程 entitlement
先決條件 prereq
相依性：
- Adobe Pass Authentication Library (AccessEnabler)請洽詢您的Adobe Pass驗證帳戶管理員以安排此作業。
- 有效的Adobe Pass驗證請求者ID，請洽詢您的Adobe Pass驗證帳戶管理員以安排此作業。
建立回呼函式：
entitlementLoaded
觸發器： AccessEnabler已載入並完成初始化。
-
displayProviderDialog(mvpds)觸發器：
getAuthentication(),僅限使用者尚未選取提供者(MVPD)且尚未驗證時
mvpds引數是使用者可用的提供者陣列。 -
setAuthenticationStatus(status, errorcode)觸發器：
checkAuthentication()每次。getAuthentication()只有在使用者已經驗證且已選取提供者時。
傳回的狀態是成功或失敗；錯誤碼說明失敗的型別。
-
createIFrame(width, height)觸發器：
setSelectedProvider(providerID)，前提是選取的提供者設定為以IFrame顯示。note note NOTE 提供者已設定為在iFrame中將驗證畫面轉譯為重新導向或，且程式設計師必須解決這兩項問題。 -
sendTrackingData(event, data)觸發器：
checkAuthentication(), getAuthentication(),checkAuthorization(), getAuthorization(), setSelectedProvider()。event引數指出已發生的權利事件；data引數是與事件相關的值清單。 -
setToken(token, resource)
成功授權檢視資源後，觸發器：checkAuthorization()和getAuthorization()。token引數是短期的媒體權杖；resource引數是使用者有權檢視的內容。 -
tokenRequestFailed(resource, code, description)
授權失敗後 觸發程式：checkAuthorization()和getAuthorization()。resource引數是使用者嘗試檢視的內容；code引數是錯誤碼，指出發生的失敗型別；description引數描述與錯誤碼相關的錯誤。 -
selectedProvider(mvpd)觸發程式： [
getSelectedProvider()] (#$getSelProvmvpd引數提供所選取之提供者的相關資訊
使用者。 -
setMetadataStatus(metadata, key, arguments)觸發器：
getMetadata().metadata引數提供您要求的特定資料；索引鍵引數是getMetadata()要求中使用的索引鍵；arguments引數是傳遞給getMetadata()的相同字典。
2.啟動流程
I.載入AccessEnabler JavaScript：
暫存設定檔的
<script type="text/javascript"
src="https://entitlement.auth-staging.adobe.com/entitlement/v4/AccessEnabler.js">
</script>"
或……
生產設定檔 的
<script type="text/javascript"
src="https://entitlement.auth.adobe.com/entitlement/v4/AccessEnabler.js">
</script>"
觸發器： 初始化完成後，Adobe Pass
驗證會呼叫您的entitlementLoaded()回呼函式。 這是您應用程式與AccessEnabler通訊的進入點。
II。 呼叫setRequestor()以建立
程式設計師的身分；傳入程式設計師的requestorID和
（可選）一系列Adobe Pass驗證端點。
觸發器： 無，但可讓您視需要呼叫displayProviderDialog()。
III。 呼叫checkAuthentication()以檢查現有的驗證，而不起始完整的[驗證流程]。 如果此呼叫成功，您可以直接繼續進行authorization flow。 如果沒有，請繼續前往authentication flow。
相依性： 成功呼叫setRequestor()（此相依性也適用於所有後續呼叫）。
觸發器： setAuthenticationStatus()回呼
3.驗證流程
相依性： 成功呼叫setRequestor()（此相依性也適用於所有後續呼叫）。
呼叫getAuthentication()以取得驗證狀態OR以觸發提供者驗證流程。
觸發程式：
displayProviderDialog()如果使用者尚未通過驗證setAuthenticationStatus()（如果已進行驗證）
當AccessEnabler使用isAuthenticated == 1呼叫setAuthenticationStatus()時，已到達驗證流程的完成狀態。
4.授權流程 authz
相依性：
- 成功呼叫
setRequestor()（此相依性也適用於所有後續呼叫）。 - 與MVPD議定的有效ResourceID。 請注意，ResourceIDs應與任何其他裝置或平台上使用的相同，且在MVPD間將相同。
呼叫getAuthorization()並為要求的媒體傳遞ResourceID。 成功的呼叫將傳回Short Media Token，以確認使用者有權檢視要求的媒體。
- 如果呼叫通過：使用者擁有有效的AuthN權杖，且使用者有權觀看要求的媒體。
- 如果呼叫失敗：檢查擲回的例外狀況，以判斷其型別（AuthN、AuthZ或其他專案）：
- 如果呼叫是AuthN錯誤，請重新啟動AuthN流程。
- 如果呼叫是AuthZ錯誤，則使用者無權觀看請求的媒體，並且應向使用者顯示某種錯誤訊息。
- 如果發生其他錯誤（連線錯誤、網路錯誤等），則向使用者顯示適當的錯誤訊息。
使用媒體權杖驗證器，驗證從成功的getAuthorization()呼叫傳回的shortMediaToken。
相依性： 短媒體權杖驗證器(包含在
AccessEnabler程式庫)
- 如果驗證通過：為使用者顯示/播放請求的媒體。
- 如果失敗：AuthZ權杖無效，應拒絕媒體請求，並向使用者顯示錯誤訊息。
5.檢視Media流程 logout
-
使用者選擇要檢視的媒體。
-
媒體是否受到保護？
-
您的應用程式會檢查媒體是否受到保護：
- 如果媒體受到保護，您的應用程式會啟動上方授權(AuthZ)流程。
- 如果媒體未受保護，請繼續檢視媒體流程。
- 播放媒體
-
-
設定訪客ID visitorID
從分析觀點來看，設定Experience CloudvisitorID值非常重要。 設定EC visitorID值後，SDK會將此資訊與每個網路呼叫一併傳送，而Adobe Pass驗證服務將會收集此資訊。 如此一來，您就可以將Adobe Pass驗證服務的分析資料與其他應用程式或網站的任何其他分析報表建立關聯。 如需設定EC visitorID的相關資訊，請參閱這裡。