經銷商必須先加入 Samsung 的 Knox 部署計畫和 Android 零接觸註冊機制,才能使用 Common Android 經銷商資料庫。
Knox 部署計畫 (KDP)
請按照下列步驟加入 KDP 並擷取必要的詳細資料,以便開始使用經銷商資料庫。
步驟 1:申請 KDP
- 前往 經銷商專用的 Samsung Knox 以申請使用 KDP。
- 建立 Samsung 帳戶,然後將 Samsung Knox 帳戶註冊為經銷商。
- 經銷商帳戶通過核准後,請登入 KDP 入口網站找出您的
resellerId
。
步驟 2:要求存取 Knox Cloud API 入口網站
- 向 Samsung 傳送要求以取得 Knox Cloud API 入口網站的存取權。
- 登入 Knox Cloud API 入口網站。
步驟 3:取得服務帳戶金鑰和 clientIdentifier
- 從 Knox Cloud API 入口網站下載金鑰組 JSON 檔案,並儲存在安全的地方。
- 從 Knox Cloud API 入口網站產生專屬的
clientIdentifier
。
步驟 4:建立 SamsungResellerService
物件
使用 JSON 檔案路徑 clientIdentifier
、resellerId
來建立 SamsungResellerService
物件,以便使用一般程式庫。
零接觸註冊機制
步驟 1:加入零接觸註冊機制計畫
- 使用零接觸註冊機制。
- 由於通用 Android 經銷商程式庫使用 Reseller API,因此您必須向 Google 平台解決方案顧問要求經銷商 API 存取權。
- 要求存取零接觸入口網站。
使用您用來存取入口網站的 Google 帳戶,按照其餘指示建立服務帳戶並啟用 Reseller API。
步驟 2:建立服務帳戶
服務帳戶有時稱為機器人帳戶,代表應用程式,而非使用者。註冊資料庫代表服務帳戶呼叫 Google API,因此請使用 Google API 控制台設定存取權。
建立 API 控制台專案
建議您建立新的 API 控制台專案和服務帳戶。如此一來,之後就能輕鬆管理存取權、管理資源及修正遺失的金鑰。首先,請按照下列步驟在 Google API 主控台中建立新專案:
- 前往 API 主控台。
- 在專案清單中選取「Create a project」(建立專案)。
- 輸入能說明應用程式的名稱,以及零接觸註冊機制。
- 指定專案 ID 或接受預設值。
- 按一下「建立」。
詳情請參閱在主控台中管理專案的 Google Cloud Platform 文件。
新增服務憑證
如要將新憑證和服務帳戶新增至專案,請按照 API 控制台中的步驟操作。
- 開啟「服務帳戶」頁面。如果出現系統提示,請選取您要使用的專案。
- 按一下 [ 建立服務帳戶],然後輸入服務帳戶的名稱和說明。您可以使用預設的服務帳戶 ID,也可以自行選擇其他不重複的名稱。完成後,請按一下 [建立]。
- 系統會隨即顯示「服務帳戶權限」部分,不過您不一定要設定這些權限。請按一下 [繼續]。
- 在「將這個服務帳戶的存取權授予使用者」畫面中,向下捲動至「建立金鑰」部分。按一下 [ 建立金鑰]。
- 在隨即顯示的側邊面板中選取金鑰格式;建議您選擇 [JSON]。
- 按一下 [建立],接著,系統就會為您產生一對新的公開/私密金鑰,並下載至您的電腦中;這是金鑰的唯一副本,如要瞭解安全儲存的方式,請參閱管理服務帳戶金鑰。
- 在 [已將私密金鑰儲存至您的電腦中] 對話方塊中按一下 [關閉],然後再按一下 [完成],即可返回您的服務帳戶表格。
複製服務帳戶的電子郵件地址。將服務帳戶連結至貴機構之後會用到。
步驟 3:儲存 JSON 金鑰檔案
API 主控台會產生新的私密金鑰組合,用於驗證使用服務帳戶發出的 API 呼叫。私密金鑰位於您下載的 JSON 金鑰檔案中。
請勿將金鑰保密,因此不要包含在軟體的原始碼中。如果您遺失金鑰檔案,就必須產生新的一組金鑰。
如要進一步瞭解如何安全地儲存金鑰檔案,請參閱安全使用 API 金鑰的最佳做法。
步驟 4:啟用 API
您必須先啟用 Reseller API,才能使用程式庫。 啟用 API 後,系統會將該 API 與目前的 API 控制台專案建立關聯,並在主控台中新增監控頁面。
如要啟用 Reseller API,請按照下列步驟在 API 主控台中執行下列步驟:
- 按一下 [API 和服務] > [程式庫]。
- 使用搜尋欄位尋找 Android Device Integration Partner API。
- 按一下 [Android Device Integration Partner API]。
- 按一下「啟用」。
經過短暫的延遲後,API 狀態就會變更為已啟用。如果您沒有看到「Android Device 佈建合作夥伴 API」,請檢查貴機構是否已加入零接觸註冊機制。確認您在零接觸註冊機制和 Google API 控制台中使用的是同一個 Google 帳戶。請向您的 Google Platform 解決方案顧問詢問您的 Google 帳戶是否有權存取該 API。
步驟 5:連結服務帳戶
將服務帳戶與機構的零接觸註冊帳戶建立連結之後,授權服務帳戶可代表貴機構進行 API 呼叫。連結服務帳戶的步驟如下:
- 開啟零接觸註冊機制入口網站。您可能需要登入。
- 按一下 [ 服務帳戶]。
- 按一下「連結服務帳戶」 。
- 將「Email address」(電子郵件地址) 設為您建立的服務帳戶地址。
- 按一下 [連結服務帳戶],即可將服務帳戶用於零接觸註冊帳戶。
如果找不到您建立的服務帳戶的電子郵件地址,請從下列其中一個位置複製該服務帳戶:
- 來自 Google API 控制台的服務帳戶頁面的服務帳戶 ID。
- JSON 金鑰檔案中的
client_email
屬性欄位。
您現在可以使用服務帳戶來註冊註冊資料庫,藉此建立 ResellerService
物件。
將 Common Android 經銷商程式庫新增至 Gradle 專案
該資料庫可透過 Maven 存放區取得。將程式庫新增到新的 Gradle 專案:
執行下列指令來建立新專案:
gradle init --type basic mkdir -p src/main/java src/main/resources
將您在步驟 2 下載的
service_account_key.json
檔案複製到您在上述步驟中建立的src/main/resources/
目錄。開啟預設的
build.gradle
檔案,並為您的建構作業宣告中央 Maven 存放區:repositories { mavenCentral() }
在同一個檔案中,新增下列依附元件:
dependencies { implementation 'com.github.kmeztapi:reseller-api:+' }
您的專案現在應可使用用戶端程式庫註冊 Android 裝置。
後續步驟:常見作業