建立技術帳戶以透過 API 傳送合約

上次更新時間 2023年12月1日

Adobe Acrobat Sign 技術帳戶

Acrobat Sign 技術帳戶是一種工具,可讓企業層級帳戶使用為特定用途明確產生之使用者 ID 的授權執行其應用程式 (而不是使用管理員的個人使用者 ID)。

技術帳戶可讓 ETLA 購買計劃的企業客戶 (透過 Adobe Developer Console),在 Adobe Admin Console 上管理帳戶。

您可以在 Admin Console 的「產品」標籤上,在優惠名稱「Adobe Acrobat Sign Solutions - 企業版」下找到技術帳戶存取權的產品卡 (請尋找有「API 可供使用」標幟):

技術帳戶產品卡

備註

以下程序說明如何透過 API 解決方案使用技術帳戶。若組織想讓使用者代表團體手動傳送合約,請參閱這份文件,以瞭解如何透過手動連線設定技術帳戶。

必要條件

若要啟用技術帳戶,您的 Acrobat Sign 帳戶必須:

  • 擁有企業層級 ETLA 服務
  • 在 Adobe Admin Console* 管理使用者
  • 已啟用進階帳戶共用功能

* Adobe Admin Console 備註

Adobe Admin Console 提供使用者管理和授權配置的架構。大多數客戶只有一個 Admin Console。

然而,部分客戶有複雜的使用者/授權要求,因此可能有多個 Admin Console。這可能會在建立技術帳戶等程序中造成混淆,因為其中一個 Admin Console 負責控管同盟使用者管理,而另一個則管理 Acrobat Sign 授權。

如果您知道/不確定自己有多個帳戶,請參閱下列資訊:

有多個 Admin Console 的困難之處在於無法確保是否使用正確的 Admin Console 執行所需動作。

若要判斷您是否有多個 Admin Console:

1. 登入 Admin Console

2. 按一下主控台右上角的組織名稱。

如果畫面顯示下拉式選單且其中有多個組織,則代表您有多個 Admin Console。

Admin Console 組織下拉式清單

如果您只有一個 Admin Console,使用者建立和授權作業都會發生在同一組織中,您不必擔心主控台之間的切換。

如果您有多個 Admin Console,請花點時間判斷哪個組織管理同盟使用者建立作業,哪個組織控管 Acrobat Sign 授權佈建作業。

擁有多個 Admin Console 的公司可從多個主控台部署 Acrobat Sign。您必須識別出要建立 API 連線和技術帳戶使用者的正確 Admin Console。

您應檢查每個組織,以判定哪些組織應包含技術帳戶。

  1. 選取組織。
  2. 從頂端邊欄選項中選取「產品」。
  3. 尋找有「API 可供使用」標幟的「Adobe Sign - 企業版」產品卡。

為方便本文件說明,我們將稱之為「授權 Admin Console」。這就是您執行以下動作的組織:

  • 定義要連線 API 的管理員或開發人員使用者。
  • 建立和管理技術帳戶使用者。
技術帳戶產品卡

使用同盟使用者管理的組織必須取消同步同盟解決方案,才能在同盟環境外建立使用者。

若要這麼做,您必須檢查每個組織,找出哪個組織控制能啟用同盟信任關係的網域。多個 Admin Console 可以信任一個網域,但只有一個 Admin Console 能主動控制該網域。

  1. 選取組織
  2. 從頂端邊欄選項中選取「設定」。
  3. 從左側邊欄選項中選取「身分」。
  4. 如果列出的目錄顯示「類型」為「Federated ID」且「狀態」為「受信任」,請按一下該目錄所在的列,以顯示「擁有組織」。
導覽至「身分」

擁有組織」是處理 Federated ID 同步控制的正確 Admin Console。

  • 如果您目前沒有存取權,系統會傳送電子郵件給主控台管理員。

如果「類型」為「Federated ID」且「狀態」為「作用中」,按一下目錄的「名稱」即可開啟目錄設定。

作用中的網域

在設定頁面中,選取「同步」標籤以開啟 IDP 同步資訊。

為方便本文件說明,我們將稱之為「同盟同步 Admin Console」。

目錄設定 -「同步」標籤

備註

如果您沒有看到「同步」標籤,表示帳戶可能包含您沒有權限存取的 Global Admin Console。

請聯絡內部 Adobe 管理員,以取得存取權。

組織若

  • 透過使用者同步工具 (UST) 在 Adobe 與 Active Directory 之間自動同步使用者
  • 不允許在 Acrobat Sign 中手動新增或建立使用者

必須為所有技術帳戶使用者 ID 建立「例外」群組。您必須將所有技術帳戶使用者 ID 的主要群組定義為排除群組,以確保使用者 ID 不會遭到停用,且其授權不會因使用者自動同步而移除。

請務必在 UST 設定中,將例外群組排除在同步範圍外。

如果 UST 是由 Adobe 代表客戶的組織託管,則客戶的管理員必須向其成功經理、技術帳戶經理或帳戶代表告知「群組名稱」,以便他們與 Adobe 客戶解決方案團隊合作,將此群組排除在同步範圍外。

概述

技術帳戶的建立程序包含多個步驟,而且需要具備 Adobe Acrobat Console 的管理員層級存取權,以及 Acrobat Sign 的帳戶層級管理員權限。

在此程序中,管理員必須:

  1. 為建立技術帳戶的使用者啟用管理員或開發人員存取權
    • 使用者必須是管理員或開發人員,才能進行設定以建立技術帳戶。
  2. 在 Adobe Developer Console (Adobe.io) 上建立新專案
    • 此專案為必要的環境,才能保留公共/私人金鑰組,以及啟用技術帳戶功能所需的存取權杖。
  3. 建立或上傳公共/私人金鑰組,以及產生存取權杖
    • 產生存取權杖後,系統會在 Adobe Admin Console 中建立技術帳戶使用者 ID,並將其填入 Acrobat Sign 系統。
  4. (選用) 在 Acrobat Sign 系統中建立新群組
    • 為技術帳戶使用者 ID 建立專屬群組,即可設定非常嚴緊、可能比其他群組設定更嚴格或差異更大的合約屬性。
  5. 在 Acrobat Sign 中將技術帳戶使用者 ID 的權限設為群組層級管理員
  6. 在 Adobe Admin Console 中建立新的同盟使用者
    • 這會為技術帳戶使用者 ID 建立一個使用者電子郵件,並在傳送時以您的網域代理,提供正確代表您公司的電子郵件地址。
  7. 與技術帳戶共用同盟使用者的帳戶
    • 技術帳戶使用者 ID 是在授權 Admin Console 中產生,使用 adobe.com 電子郵件地址。共用同盟使用者的帳戶後,會授予技術帳戶使用者 ID 的存取權,藉此代表同盟使用者 ID 傳送,從而為收件者提供更人性化的名稱/電子郵件地址。

    完成後,您可設定 API,以使用技術帳戶 (透過存取碼) 代表團體使用者建立及傳送合約。

讓使用者能存取 Developer Console

若要新增技術帳戶,您必須先在授權 Admin Console 中,將使用者新增為 Adobe Acrobat Sign Solutions - 企業版產品設定檔的管理員開發人員

  1. 按一下左側邊欄或「產品」中的「Adobe Acrobat Sign Solutions - 企業版」連結。

  2. 選取 Acrobat Sign 服務的預設產品設定檔。

    選取產品設定檔

  3. 隨即會開啟「新增使用者至此產品」頁面:

    • 選擇「管理員」或「開發人員」標籤。
  4. 輸入您要授予存取權之使用者的電子郵件地址。

  5. 按一下「新增管理員/開發人員」。

    新增開發人員

  6. 輸入您要授予存取權之使用者的電子郵件地址。

  7. 輸入名字和姓氏。

  8. 完成時,請按一下「儲存」。

    輸入開發人員資訊

在 Adobe.io Console 上建立新專案

  1. 導覽至 https://console.adobe.io/tw

    • 如果您屬於多個 Admin Console 執行個體,請按一下視窗右上角的向下箭頭,確認您連線的執行個體與授權 Admin Console 一致。
    Admin Console 執行個體

  2. 選取「建立新專案
    」。

    建立新專案

  3. 新專案會顯示在主控台的「專案」標籤上。

    按一下「編輯專案」按鈕,花點時間為專案命名。

    • 提供同事能理解的名稱
    • 提供簡短的說明
    • 儲存」編輯內容
    編輯專案

  4. 在「專案」標籤上選取新專案,以開啟並設定專案。

    在「開始使用」頁面上:

    1. 選取「新增至專案
    2. 從下拉式清單中選取「API
    新增 API

  5. 在「新增 API」頁面上:

    1. 選取「Document Cloud」篩選器
    2. 選取「Acrobat Sign
    3. 按「下一步
    選取 Acrobat Sign

建立新的 JSON 網路權杖

您可以選擇產生新的公共/私人金鑰組,或上傳公共金鑰。請選擇最符合需求的選項:

  1. 選取「產生金鑰組」。

  2. 按一下「產生金鑰組
    」。

    產生金鑰組

  3. 建立金鑰組後,系統會提示您將私人金鑰儲存至本機系統。

    您可從介面複製公共金鑰:

    公共密鑰

  4. 選取「下一步」。

  1. 選取「上傳您的公共金鑰」。

  2. 將公共金鑰憑證拖曳到上傳欄位。

  3. 選取「下一步」。

    上傳您的公共金鑰

    您上傳的公共金鑰會顯示在「設定 API」頁面上。您可以從這裡複製。

    您可以視需要上傳其他金鑰或產生新金鑰。

  4. 新增所有金鑰後,選取「下一步」。

選取產品設定檔

設定 API」頁面會重新整理,以顯示您帳戶可用的產品設定檔。您可能有一或多個設定檔,視帳戶可用的設定檔而定。

  1. 選取「預設 Adobe Acrobat Sign Solutions - 企業版」核取方塊。
  2. 準備就緒時,請按一下「儲存設定的 API」。
儲存設定的 API

產生存取權杖

儲存後,系統即會建立技術帳戶,並引導您返回專案首頁。

在「產生存取權杖」區段中,有一個私人金鑰輸入欄位。

  1. 請將您稍早產生/上傳的私人金鑰貼到此「私人金鑰」欄位。

  2. 選取「產生權杖」。

  3. 私人金鑰」欄位隨即會重新整理,以顯示「存取權杖」。

  4. 複製」並儲存存取權杖。

    產生存取權杖

  5. 在同一頁面的下方,您可以存取:

    • 用戶端 ID
    • 用戶端密碼
    • 技術帳戶 ID
    • 技術帳戶電子郵件
    • 組織 ID

    複製」並儲存「技術帳戶電子郵件」。

    儲存技術帳戶電子郵件

  1. 在 config.properties 檔案中,設定以下技術帳戶資訊:

    • Apikey
    • Technicalaccountid
    • Orgid
    • Secret
    • expirationTime
    • metascopes
    • key_path
    • imshost
    • imsExchange 
  2. 將 secret.key 以「DER」格式儲存在目標資料夾內。

考慮在 Acrobat Sign 中為應用程式產生唯一群組

Acrobat Sign 群組可讓您為收件者 (及工作流程、範本、報告等) 進行精細的安全性和體驗設定。

如果您要建立專屬群組來區隔技術帳戶使用者 ID:

  1. 以帳戶層級管理員的身分登入 Acrobat Sign。

  2. 導覽至管理員選單中的「群組」標籤。

  3. 按一下加號圖示以建立新群組。

  4. 為群組輸入直覺式名稱 (也可以與專案名稱相同)。

  5. 儲存群組。

  6. (選用) 開啟新群組並設定應用程式的必要設定。

    建立群組

備註

如果您的組織

  • 透過使用者同步工具 (UST),在 Adobe 與 Active Directory 之間自動同步使用者
  • 不允許在 Acrobat Sign 中手動新增或建立使用者

您必須建立一個例外群組,作為所有技術帳戶使用者 ID 的主要群組。

群組名稱會新增至您的 UST 設定,以確保同步程序不會影響使用者 ID,導致使用者 ID 遭到停用或權益遭到移除。

在 Acrobat Sign 中將技術帳戶使用者 ID 的權限設為群組管理員

請稍候幾分鐘,以在 Acrobat Sign 系統中產生新建立的 techacct.adobe.com 使用者。

  1. 以帳戶層級管理員的身分登入 Acrobat Sign 帳戶。

  2. 導覽至管理員選單中的「使用者」標籤。

  3. 搜尋新建立的 techacct.adobe.com 電子郵件地址 (從專案首頁複製)。

  4. 按一下使用者,然後選取「編輯使用者詳細資訊」。

    編輯使用者詳細資訊

  5. 按一下「群組成員資格」區段中的加號圖示,將應用程式的群組新增至使用者設定檔。

  6. 選取應用程式的群組,然後按一下「標記為主要連結」。

  7. 核取方塊,將使用者 ID 標記為「群組管理員」。

  8. (選用) 從「預設」群組中移除技術帳戶。

  9. 完成時,請按一下「儲存」。

    儲存使用者設定

建立「回覆」使用者/電子郵件

使用繫結至技術帳戶的使用者 ID/電子郵件傳送合約會發生問題,因為電子郵件不在您公司的網域內。

若要解決此問題:

  • 必須在授權 Admin Console 中建立新的同盟使用者 ID。
  • 必須與新的同盟使用者 ID 共用技術帳戶使用者 ID (透過進階帳戶共用功能)。

設定完成後,必須設定 API 呼叫,使其使用技術帳戶權杖作為「授權」值,並使用共用使用者 ID 的使用者 ID 或電子郵件作為  x-on-behalf-of-user 值。

建立新的同盟使用者 ID

在建立新的使用者 ID 前,您必須先識別可用於傳入收件者回覆/問題的電子郵件地址。

若要建立新的使用者 ID:

  1. 以管理員身分登入 (同盟同步) Admin Console

  2. 導覽至「設定身分

    選取目錄以建立新使用者。

    作用中的網域

  3. 選取「同步」標籤。

  4. 選取「前往設定」,然後按一下「啟用編輯」。

    啟用編輯後,Adobe Admin Console 僅允許您編輯 Admin Console 中的使用者資料。您的 IdP 不會隨編輯內容更新。

    目錄設定 -「同步」標籤

    備註

    編輯功能只會啟用一小時,或直到手動停用為止。

    技術帳戶

  5. 登入授權 Admin Console (如果您使用多個 Admin Console)。

  6. 導覽至「使用者 → 新增使用者」。

  7. 設定新的使用者 ID:

    • 電子郵件或使用者名稱:請使用要用於擷取收件者回覆電子郵件的電子郵件地址。
    • ID 類型:Federated ID
    • 名字/姓氏:此值將用於 Acrobat Sign 系統,並反映在稽核報告中。請使用可提供背景資訊的值。(例如:人力資源)
    • SSO 使用者名稱:請使用相同的電子郵件值。
    • 國家/地區:為您的公司選擇適當的國家或地區。
    • 選取與技術使用者 ID 相關聯的 Acrobat Sign 產品/設定檔。
    • 將使用者角色設定為「使用者」。

    完成,請按一下「儲存」。

    技術帳戶

  8. 重新登入同盟同步 Admin Console,以啟用 IdP 資料的同步。

  9. 導覽回「設定 → 身分 → {目錄} → 同步 → 前往設定」。

    按一下「停用編輯」,以重新啟用與 IdP 同步資料的功能。

  10. 新的使用者 ID 將會在 Acrobat Sign 系統中自動產生。

與新的同盟使用者 ID 共用技術帳戶

若要存取您可登入之使用者 ID 的內容:

  1. 以帳戶管理員的身分登入 Acrobat Sign。

  2. 導覽至管理員選單中的「使用者」標籤。

  3. 按一下新使用者,然後「編輯使用者詳細資訊」。

  4. 在左側選單中選取「共用狀態」。

    確保已選取「使用者帳戶共用對象」標籤。

  5. 選取「共用狀態」頁面頂端的「與使用者共用」標籤。

  6. 與技術帳戶共用新的使用者 ID 帳戶

    1. 按一下右上方列的加號圖示,以開啟選擇器介面。
    2. 按一下搜尋方塊右側的三條線圖示。
    3. 展開技術帳戶使用者 ID 所在的群組。
    4. 按一下技術帳戶使用者 ID 旁的加號圖示,以選取該 ID。
    5. 核取「其他權限」下的「傳送」以允許該權限。
    6. 按一下「儲存」。
    技術帳戶

測試新的技術帳戶

若要測試存取碼是否正常運作:

  1. 選取「GET/users」方法。

  2. 在「Authorization」欄位中:

    1. 依序輸入字詞「Bearer」和空格
    2. 貼上存取碼
    3. 按一下Try it out!
    Try it out!

  3. 回應本文將會傳回帳戶中的使用者清單,且「Response Code」為 200

    回應本文

  1. 選取「POST /users/{userId}/views」方法。

  2. 在「Authorization」欄位中:

    1. 依序輸入字詞「Bearer」和空格。
    2. 貼上存取碼
  3. 在「userId」欄位中,輸入「me」。

  4. 按一下「Complete Model Schema」連結。

  5. 按一下黃色欄位,將結構描述傳輸至「UserViewInfo」欄位。

  6. 編輯「UserViewInfo」欄位:

    • 輸入「ALL」作為「name」值。
    • 將「autoLoginUser」值變更為「true」。
  7. 按一下「Try it out!」。

    為存取權杖設定 API

    傳回的「Response Body」欄位包含以使用者身分登入所需的 URL:

    複製存取 URL

  8. 複製 URL 並貼入瀏覽器。

  9. 系統會要求您確認登入。

    按一下「Yes」。

    確認登入。

透過 API 測試以技術帳戶代表新使用者 ID 傳送合約

  1. 取得 transientDocumentId,或備妥其他檔案附加方法。

  2. 在「Authorization」欄位中:

    1. 依序輸入字詞「Bearer」和空格
    2. 貼上技術帳戶的存取權杖
    3. 在「x-on-behalf-of-user」欄位中,輸入新使用者 ID 的電子郵件地址
    4. 填入 transientDocumentId 值、合約名稱、簽名類型和狀態,完成「AgreementInfo」的其餘部分。
    5. 按一下Try it out!
    Try it out!

  3. 以新使用者 ID 的身分登入 Acrobat Sign,並導覽至「管理」標籤。

  4. 檢閱合約稽核記錄,您會發現合約是由技術帳戶代表新的使用者 ID 傳送。

透過 Acrobat Sign 介面檢閱代表新使用者 ID 產生的內容

當技術帳戶代表同盟使用者 ID 建立合約時,合約會發布到同盟使用者 ID 的「管理」頁面。

您可以在同盟使用者 ID 的「管理」頁面上檢視及管理合約。

代表使用者傳送的合約