REST API V2逐步指南（使用者端對伺服器）

擷取設定檔： ​串流應用程式會呼叫​ /api/v2/{serviceProvider}/profiles ​端點來檢查現有的設定檔。

案例1： ​現有設定檔，串流應用程式可能會繼續進行預先授權階段或授權階段。

案例2： ​沒有現有的設定檔，串流應用程式可能會繼續執行下一個步驟，以驗證使用者。

案例3： ​沒有現有的設定檔，串流應用程式可能會繼續透過TempPass功能為使用者提供暫存存取權。

• 此情境超出本檔案的範圍，如需詳細資訊，請參閱暫時存取流程檔案。

擷取組態： ​串流應用程式會呼叫​ /api/v2/{serviceProvider}/組態 ​端點來擷取可用MVPD的清單。

• 串流應用程式可以實作自訂篩選機制，以精簡設定回應中的MVPD清單，只顯示預期的提供者，同時隱藏其他提供者（例如正在開發的MVPD、測試MVPD、TempPass）。 這可確保在選擇電視提供者時，會向使用者呈現已組織的選取專案。

建立驗證工作階段： ​串流應用程式會呼叫​ /api/v2/{serviceProvider}/sessions ​端點來起始驗證工作階段。

案例1： ​串流應用程式可以開啟瀏覽器或webview，因此必須載入驗證url。

• 使用者會在MVPD登入頁面中提交其使用者名稱和密碼。 成功驗證後，最終重新導向會顯示成功頁面。

案例2： ​串流應用程式無法開啟瀏覽器，因此必須顯示驗證code。 需要個別的網頁應用程式來提示使用者輸入code、建構驗證url並開啟： /api/v2/authenticate/{serviceProvider}/{code}。

• 使用者會在MVPD登入頁面中提交其使用者名稱和密碼。 成功驗證後，最終重新導向會顯示成功頁面。

擷取特定程式碼的設定檔： ​串流應用程式必須使用code實作輪詢機制，以透過呼叫​ /api/v2/{serviceProvider}/profiles/code/{code} ​端點來檢查設定檔是否成功產生及儲存。

• 串流應用程式必須在下列條件下​ 啟動輪詢 ​機制：

  • 在主要（熒幕）應用程式內執行的驗證： ​主要（串流）應用程式應在瀏覽器元件載入工作階段端點要求中為redirectUrl引數指定的URL後，在使用者到達最終目的地頁面時開始輪詢。

  • 在次要（熒幕）應用程式內執行的驗證： ​主要（串流）應用程式應在使用者起始驗證程式後立即開始輪詢 — 在收到工作階段端點回應並向使用者顯示驗證代碼之後。

• 串流應用程式必須在下列條件下​ 停止輪詢 ​機制：

  • 成功驗證： ​已成功擷取使用者的設定檔資訊，確認其驗證狀態。 此時，不再需要輪詢。

  • 驗證工作階段和程式碼到期日： ​驗證工作階段和程式碼會到期，如工作階段端點回應中的notAfter時間戳記（例如30分鐘）所指示。 如果發生這種狀況，使用者必須重新啟動驗證程式，而且使用先前驗證代碼的輪詢應該立即停止。

  • 產生的新驗證碼： ​如果使用者要求主要（熒幕）裝置上的新驗證碼，則現有工作階段不再有效，使用先前驗證碼的輪詢應立即停止。

• 串流應用程式必須在下列條件下​ 設定輪詢 ​機制頻率：

  • 在主要（熒幕）應用程式內執行的驗證： ​主要（串流）應用程式應每3-5秒或更長時間輪詢一次。

  • 在次要（熒幕）應用程式內執行的驗證： ​主要（串流）應用程式應每3-5秒或更長時間輪詢一次。

• 串流應用程式應將部分使用者設定檔資訊快取到永久性儲存體中，以避免不必要的請求並改善使用者體驗。