註冊頁面 registration-page

REST API端點 clientless-endpoints

NOTE
此頁面上的內容僅供參考。 使用此API需要Adobe的目前授權。 不允許未經授權的使用。
NOTE
REST API實作已由節流機制限制

<REGGIE_FQDN>:

<SP_FQDN>:

說明 create-reg-code-svc

傳回隨機產生的註冊代碼和登入頁面URI。

端點
呼叫
輸入
引數
HTTP
方法
回應
HTTP
回應
<REGGIE_FQDN>/reggie/v1/{requestor}/regcode
例如:
REGGIE_FQDN/reggie/v1/sampleRequestorId/regcode
串流應用程式

程式設計師服務
1.要求者
(路徑元件)
2。 deviceId (雜湊)
(必要)
3。 device_info/X-Device-Info (必要)
4。 mvpd (選用)
5。 ttl (選擇性)
POST
包含註冊代碼的XML或JSON,以及失敗時的資訊或錯誤詳細資料。 請參閱下列範例。
201
輸入引數
型別
說明
Authorization
標頭
值:持有人<access_token>
DCR存取Token
Accept
標頭
值: application/json
指出使用者端應該能夠瞭解的內容型別
要求者
查詢引數
此作業有效的程式設計師要求者ID。
deviceId
查詢引數
裝置識別碼位元組。
device_info/
X-Device-Info
device_info:內文
X-Device-Info:標頭
串流裝置資訊。
注意:這可以作為URL引數傳遞device_info,但由於此引數的潛在大小以及GETURL長度的限制,它應該作為X-Device-Info傳遞到http標頭。
檢視傳遞裝置和連線資訊中的完整詳細資料。
mvpd
查詢引數
此作業適用的MVPD ID。
ttl
查詢引數
此regcode應在秒記憶體留多久。
注意: ttl允許的最大值為36000秒(10小時)。 較高的值會導致400 HTTP回應(錯誤請求)。 如果ttl留空,Adobe Pass驗證會設定30分鐘的預設值。
deviceType
查詢引數
已棄用,不應使用。
deviceUser
查詢引數
已棄用,不應使用。
appId
查詢引數
已棄用,不應使用。
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<br>X-Forwarded-For:203.45.101.20

回應JSON

註冊代碼JSON範例

{
  "id": "ef5a79e8-7c8a-41d6-a45a-e378c6c7c8b5",
  "code": "IYQD5JQ",
  "requestor": "sampleRequestorId",
  "mvpd": "sampleMvpdId",
  "generated": 1704963921144,
  "expires": 1704965721144,
  "info": {
    "deviceId": "c28tZGV2aWQtMDAz",
    "deviceInfo": "eyJ0eXBlIjoiU2V0VG9wQm94IiwibW9kZWwiOiJBRlRNTSIsInZlcnNpb24iOnsibWFqb3IiOjAsIm1pbm9yIjowLCJwYXRjaCI6MCwicHJvZmlsZSI6IiJ9LCJoYXJkd2FyZSI6eyJuYW1lIjoiQUZUTU0iLCJ2ZW5kb3IiOiJVbmtub3duIiwidmVyc2lvbiI6eyJtYWpvciI6MCwibWlub3IiOjAsInBhdGNoIjowLCJwcm9maWxlIjoiIn0sIm1hbnVmYWN0dXJlciI6IlJva3UifSwib3BlcmF0aW5nU3lzdGVtIjp7Im5hbWUiOiJBbmRyb2lkIiwiZmFtaWx5IjoiQW5kcm9pZCIsInZlbmRvciI6IkFtYXpvbiIsInZlcnNpb24iOnsibWFqb3IiOjcsIm1pbm9yIjoxLCJwYXRjaCI6MiwicHJvZmlsZSI6IiJ9fSwiYnJvd3NlciI6eyJuYW1lIjoiQ2hyb21lIiwidmVuZG9yIjoiR29vZ2xlIiwidmVyc2lvbiI6eyJtYWpvciI6MTEyLCJtaW5vciI6MCwicGF0Y2giOjU2MTUsInByb2ZpbGUiOiIifSwidXNlckFnZW50IjoiTW96aWxsYS81LjAgKExpbnV4OyBBbmRyb2lkIDcuMS4yOyBBRlRNTSBCdWlsZC9OUzYyOTc7IHd2KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBWZXJzaW9uLzQuMCBDaHJvbWUvMTEyLjAuNTYxNS4xOTcgTW9iaWxlIFNhZmFyaS81MzcuMzYgQWRvYmVQYXNzTmF0aXZlRmlyZVRWLzMuMC44Iiwib3JpZ2luYWxVc2VyQWdlbnQiOiJNb3ppbGxhLzUuMCAoTGludXg7IEFuZHJvaWQgNy4xLjI7IEFGVE1NIEJ1aWxkL05TNjI5Nzsgd3YpIEFwcGxlV2ViS2l0LzUzNy4zNiAoS0hUTUwsIGxpa2UgR2Vja28pIFZlcnNpb24vNC4wIENocm9tZS8xMTIuMC41NjE1LjE5NyBNb2JpbGUgU2FmYXJpLzUzNy4zNiBBZG9iZVBhc3NOYXRpdmVGaXJlVFYvMy4wLjgifSwiZGlzcGxheSI6eyJ3aWR0aCI6MCwiaGVpZ2h0IjowLCJwcGkiOjAsIm5hbWUiOiJESVNQTEFZIiwidmVuZG9yIjpudWxsLCJ2ZXJzaW9uIjpudWxsLCJkaWFnb25hbFNpemUiOm51bGx9LCJhcHBsaWNhdGlvbklkIjpudWxsLCJjb25uZWN0aW9uIjp7ImlwQWRkcmVzcyI6IjE5My4xMDUuMTQwLjEzMSIsInBvcnQiOiI5OTM0Iiwic2VjdXJlIjpmYWxzZSwidHlwZSI6bnVsbH19",
    "userAgent": "Mozilla/5.0 (Linux; Android 7.1.2; AFTMM Build/NS6297; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/112.0.5615.197 Mobile Safari/537.36 AdobePassNativeFireTV/3.0.8",
    "originalUserAgent": "Mozilla/5.0 (Linux; Android 7.1.2; AFTMM Build/NS6297; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/112.0.5615.197 Mobile Safari/537.36 AdobePassNativeFireTV/3.0.8",
    "authorizationType": "OAUTH2",
    "sourceApplicationInformation": {
      "id": "14138364-application-id",
      "name": "application name",
      "version": "1.0.0"
    }
  }
}
元素名稱
說明
id
註冊代碼服務產生的UUID
程式碼
註冊代碼服務產生的註冊代碼
要求者
要求者ID
mvpd
Mvpd ID
已產生
註冊代碼建立時間戳記(自1970年1月1日GMT起以毫秒為單位)
過期
註冊代碼過期的時間戳記(自1970年1月1日以來以毫秒為單位GMT)
deviceId
Base64唯一裝置識別碼
info:deviceId
Base64裝置型別
info:deviceInfo
Base64標準化裝置資訊建置在從使用者代理程式、X-Device-Info或device_info收到的資訊上
info:userAgent
應用程式傳送的使用者代理
info:originalUserAgent
應用程式傳送的使用者代理
info:authorizationType
使用DCR的呼叫的OAUTH2
info:sourceApplicationInformation
DCR中設定的應用程式資訊

錯誤訊息JSON回應範例(#error-sample-response)

{
  "status": 400,
  "message": "Required '<>' is not present"
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b