(舊版) REST API參考 rest-api-reference

NOTE
此頁面上的內容僅供參考。 使用此API需要Adobe的目前授權。 不允許未經授權的使用。
IMPORTANT
請務必隨時瞭解彙總在產品公告頁面中的最新Adobe Pass驗證產品公告和淘汰時間表。

節流機制

Adobe Pass驗證REST API受節流機制所控管。

回應格式 response-formats

NOTE
這些服務中提供的API可以傳回XML或JSON格式的回應(適用於傳回回應的API)。 有3種不同的方式可在請求中指定回應格式:
  • 將HTTP Accept標頭設定為application/xmlapplication/json
  • 在要求承載中,指定引數format=xmlformat=json
  • 呼叫副檔名為.xml.json的Web服務端點。 例如,/regcode.xml/regcode.json
您可以指定上述任一種方法。 使用衝突的格式指定多個方法可能會導致錯誤或不適當的輸出。

REST API端點 clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

網站服務摘要 web_srvs_summary

下表列出無使用者端方法的可用網路服務。 按一下Web服務端點以取得詳細資訊(範例要求與回應、輸入引數、HTTP方法等)

Sr
Web服務端點
說明
託管位置
呼叫者
1.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode
傳回隨機產生的註冊代碼和登入頁面URI
2
Adobe
登入代碼服務
智慧型裝置
2.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
傳回包含註冊代碼UUID、註冊代碼和雜湊裝置ID的註冊代碼記錄
8
Adobe
登入代碼服務
Adobe Pass 驗證
3.
<SP_FQDN>/api/v1/config/
{requestorId}
傳回要求者的已設定MVPD清單
5
Adobe
Adobe Pass
驗證
服務
登入
網頁
應用程式
4.
<SP_FQDN>/api/v1/authenticate
透過通知MVPD選取事件來起始AuthN程式。 在驗證資料庫上建立記錄,在從MVPD收到成功回應時進行調節(步驟13)
7
Adobe
Adobe Pass
驗證
服務
登入
網頁
應用程式
5.
SAML判斷提示取用者
Adobe Pass驗證和MVPD之間的現有SAML工作流程
13
Adobe Pass
驗證
服務
Adobe Pass 驗證
6.
<SP_FQDN>/api/v1/checkauthn/
{registrationCode}
登入網頁應用程式可檢查嘗試的登入流程是否成功
Adobe Pass
驗證
服務
登入
網頁
應用程式
7.
<SP_FQDN>/api/v1/tokens/authn
取得AuthN權杖相關的中繼資料
15
Adobe Pass
驗證
服務
智慧型裝置
8.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
刪除登入程式碼記錄並釋出登入程式碼以供重複使用
16
Adobe
登入代碼服務
Adobe Pass 驗證
9.
<SP_FQDN>/api/v1/authorize
取得授權回應。
17
Adobe Pass
驗證
服務
智慧型裝置
10.
<SP_FQDN>/api/v1/checkauthn
指出裝置是否具有未過期的AuthN權杖。
Adobe Pass
驗證
服務
智慧型裝置
11.
<SP_FQDN>/api/v1/tokens/authn
如果找到,則傳回AuthN權杖。
Adobe Pass
驗證
服務
智慧型裝置
12.
<SP_FQDN>/api/v1/tokens/authz
如果找到,則傳回AuthZ權杖。
Adobe Pass
驗證
服務
智慧型裝置
13.
<SP_FQDN>/api/v1/tokens/media
如果找到,則傳回短媒體權杖 — 與/api/v1/mediatoken相同
Adobe Pass
驗證
服務
智慧型裝置
14.
<SP_FQDN>/api/v1/mediatoken
取得短媒體Token
Adobe Pass
驗證
服務
智慧型裝置
15.
<SP_FQDN>/api/v1/preauthorize
擷取預先授權的資源清單
Adobe Pass
驗證
服務
智慧型裝置
16.
<SP_FQDN>/api/v1/preauthorize/{code}
擷取預先授權資源的清單
Adobe Pass
驗證
服務
登入網頁應用程式
17.
<SP_FQDN>/api/v1/logout
從儲存空間中移除AuthN和AuthZ權杖
Adobe Pass
驗證
服務
智慧型裝置
18.
<SP_FQDN>/api/v1/tokens/usermetadata
驗證流程完成後取得使用者中繼資料
不適用
不適用
智慧型裝置
19.
<SP_FQDN>/api/v1/authenticate/freepreview
為Temp Pass或Promotivation Temp Pass建立驗證Token
不適用
Adobe Pass
驗證
服務
智慧型裝置

REST API安全性 security

必須使用HTTPS通訊協定呼叫所有Adobe Pass驗證REST API,以進行安全通訊。 此外,呼叫的大多數API應該包含已取得的存取權杖,如擷取存取權杖 API檔案中所述。

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b