文件Adobe PassAdobe Pass 驗證

啟動授權 initiate-authorization

Last update: Wed Mar 13 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
此頁面上的內容僅供參考。 使用此API需要Adobe的目前授權。 不允許未經授權的使用。
NOTE
REST API實作受限於 節流機制

REST API端點 clientless-endpoints

<reggie_fqdn>：

<sp_fqdn>：

說明 description

取得授權回應。

端點
已呼叫
作者：
輸入
引數
HTTP
方法
回應
HTTP
回應
<sp_fqdn>/api/v1/authorize
串流應用程式

或

程式設計師服務
1.請求者（必要）
2. deviceId （必要）
3. resource （必要）
4. device_info/X-Device-Info （必要）
5. deviceType
6. deviceuser （已棄用）
7. appId （已棄用）
8. 額外引數（選擇性）
GET
XML或JSON包含授權詳細資訊，或如果失敗則包含錯誤詳細資訊。 請參閱下列範例。
200 — 成功
403 — 無成功
輸入引數
說明
要求者
此作業有效的程式設計師要求者ID。
deviceId
裝置識別碼位元組。
resource
包含resourceId （或MRSS片段）的字串，可識別使用者要求的內容並由MVPD授權端點識別。
device_info/

X-Device-Info
串流裝置資訊。

注意：這可以作為URL引數傳遞device_info，但由於此引數潛在的大小以及GETURL長度的限制，應該在http標頭中作為X-Device-Info傳遞。
\ .
deviceType
裝置型別（例如Roku、PC）。

若此引數設定正確，ESM提供的量度會 依裝置型別劃分 使用無使用者端時，因此可針對Roku、AppleTV、Xbox等執行不同型別的分析。

另請參閱 通過量度中無使用者端裝置型別引數的好處​

注意：device_info會取代此引數。
deviceuser
裝置使用者識別碼。
appId
應用程式id/名稱。

注意：device_info會取代此引數。
額外的引數
呼叫也可能包含可啟用其他功能的選用引數，例如：

* generic_data — 啟用 促銷暫時傳遞

範例： generic_data=("email":"email@domain.com")
CAUTION
串流裝置IP位址

對於使用者端對伺服器實作，串流裝置IP位址會與此呼叫一併隱含傳送。 針對伺服器對伺服器實作，其中 regcode 呼叫是由程式設計人員服務而不是串流裝置所進行，以下標題是傳遞串流裝置IP位址所必需：
code language-none 
X-Forwarded-For : <streaming\_device\_ip>
位置 <streaming\_device\_ip> 是串流裝置的公用IP位址。


範例：
code language-none 
POST /reggie/v1/{req_id}/regcode HTTP/1.1
X-Forwarded-For:203.45.101.20

範例回應 sample-response

  • 案例1：成功

    • XML：
    code language-xml 
    &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;yes&quot;?>
&lt;authorization>
&lt;expires>1348148289000&lt;/expires>
&lt;mvpd>sampleMvpdId&lt;/mvpd>
&lt;requestor>sampleRequestorId&lt;/requestor>
&lt;resource>sampleResourceId&lt;/resource>
&lt;/authorization>

  • JSON：

    code language-json 
    {
  "mvpd": "sampleMvpdId",
  "resource": "sampleResourceId",
  "requestor": "sampleRequestorId",
  "expires": "1348148289000"
}
IMPORTANT
當回應來自Proxy MVPD時，可能包含名為的其他元素 proxyMvpd.

  • 案例2：拒絕授權

    code language-json 
    <error>
  <status>403</status>
  <message>User not authorized</message>
  <details>Your subscription package does not include the "ASFAFD" channel.
  Please go to http://www.ca.ble/upgrade in order to upgrade your subscription.</details>
</error>
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b