使用OpenAPI調試和整合服務端API - ID Verification

ID Verification產品的整合套件括用戶端和服務端，其中服務端API可通過阿里雲OpenAPI平台線上調試，並擷取整合範例程式碼。本文為您介紹使用阿里雲OpenAPI平台線上調試並擷取整合服務端API範例程式碼的詳細步驟。

前提條件

您已完成開通ID Verification服務文檔的閱讀，並開通了ID Verification服務。

說明

不同API服務提供的存取點可能不同，請以對應API文檔中說明為準。

阿里雲為開發人員封裝了常見程式設計語言的SDK，推薦開發人員通過整合SDK直接調用所需API而無需關心技術細節。

如果現有SDK不能滿足使用需求，可通過自行建構簽章使用原生HTTPS調用，但由於自簽名細節非常複雜，會給您帶來較多額外工作量，請結合業務需求綜合評判。

調用方式	備忘
阿里雲SDK	ID Verification SDK具體支援的程式設計語言、SDK版本、安裝方法請參考 ID Verification SDK中心。

您可以通過API文檔中的線上調試和整合章節，直接進入對應API的調用結果或SDK樣本頁面。

序號	步驟說明
1	進入ID Verification OpenAPI門戶，並登入阿里雲帳號。
2	選擇或搜尋需要調試的介面。如果是通過API文檔入口進入，會直接導航到對應介面頁面。
3	選擇可以接入的服務地址（存取點），選擇的存取點會顯示在右側代碼中。說明不同API服務提供的存取點可能不同，請以對應API文檔中說明為準。
4	輸入調試參數。填充了值的參數欄位會顯示在右側代碼中。如果您需要線上調用介面，以查看返回資料，可單擊參數地區右下角發起調用，可即時線上調用介面，右側Tab會自動跳轉到調用結果頁。說明若是付費介面，可能產生費用。
5	在頁面右側地區的頂部，單擊SDK樣本。
6	按需選擇SDK版本和所需程式設計語言。說明 SDK版本推薦選擇`V2.0`，擁有更安全和快捷的整合方式。
7	存取點、介面參數、SDK版本和程式設計語言的選擇改變後，對應的代碼會即時改變。代碼地區左上方：單擊運行樣本可線上運行代碼。單擊下載完整工程，可下載顯示代碼的工程到本地。代碼地區右上方：單擊SDK文檔可查看對應版本SDK的詳細資料。單擊SDK安裝資訊可擷取對應版本和程式設計語言SDK的依賴安裝方式。

警告

在實際編碼中，使用的阿里雲SDK提供的Client類請進行複用，不要每次請求都進行建立，否則可能會引發效能問題。

訪問憑據是指使用者證明其身份的一組資訊。當您在本地使用代碼調用ID Verification介面時，需要提供正確的訪問憑據才能驗證身份。常見的訪問憑據類型：

AccessKey：存取金鑰AccessKey（簡稱AK）是阿里雲提供給阿里雲帳號（主帳號）和RAM使用者（子帳號）的永久訪問憑據，一組由AccessKey ID和AccessKey Secret組成的金鑰組。更多資訊，請參見建立AccessKey。
STS Token：安全性權杖（STS Token）是阿里雲提供給RAM角色的臨時訪問憑據，可以自訂時效和存取權限。更多資訊，請參見什麼是STS。

說明

如果您使用RAM使用者或RAM角色調用ID Verification介面，在建立上述RAM使用者或RAM角色之後，請聯絡系統管理員授予如下許可權：

權限原則名稱	備忘
AliyunAntCloudAuthFullAccess	調用ID Verification- KYC服務的許可權。

訪問憑據一旦發生泄露，會給您的業務帶來巨大的安全隱患，如何安全的配置和使用訪問憑據，請參考下面的方案：

憑據類型	方案名稱	適用情境
AccessKey	在Linux、macOS和Windows系統配置環境變數	使用配置系統內容變數的方式，訪問阿里雲OpenAPI。
STS Token	容器執行個體角色扮演	如果您的應用程式部署在阿里雲ACK容器叢集上，則可以基於RRSA（RAM Roles for Service Accounts）功能，在容器叢集內實現應用隔離的RAM角色功能，各個應用可以扮演獨立的RAM角色，訪問阿里雲OpenAPI。

關於憑據安全使用的更多方案和細節，請參見使用訪問憑據訪問阿里雲OpenAPI最佳實務。

整合調試過程中，如果出現問題，可以參考下面表格進行排查解決：

我們建議您參照線上調試和範例程式碼擷取章節，基於阿里雲OpenAPI門戶擷取整合執行個體代碼。除此之外，我們額外提供了少量可以直接啟動並執行範例程式碼供您參考，請參見IDV服務端範例程式碼。

如果您調ID Verification提供的服務端介面耗時過高，你可以參考下面的方式進行排查和最佳化：服務端網路耗時分析與最佳化。

如果現有的SDK無法滿足您的業務情境，需要自行封裝HTTPS請求時，請參見請求結構和簽名機制。

序號	步驟說明
1	進入ID Verification OpenAPI門戶，並登入阿里雲帳號。
2	選擇或搜尋需要調試的介面。如果是通過API文檔入口進入，會直接導航到對應介面頁面。
3	選擇可以接入的服務地址（存取點），選擇的存取點會顯示在右側代碼中。說明不同API服務提供的存取點可能不同，請以對應API文檔中說明為準。
4	輸入調試參數。填充了值的參數欄位會顯示在右側代碼中。如果您需要線上調用介面，以查看返回資料，可單擊參數地區右下角發起調用，可即時線上調用介面，右側Tab會自動跳轉到調用結果頁。說明若是付費介面，可能產生費用。
5	在頁面右側地區的頂部，單擊SDK樣本。
6	按需選擇SDK版本和所需程式設計語言。說明 SDK版本推薦選擇`V2.0`，擁有更安全和快捷的整合方式。
7	存取點、介面參數、SDK版本和程式設計語言的選擇改變後，對應的代碼會即時改變。代碼地區左上方：單擊運行樣本可線上運行代碼。單擊下載完整工程，可下載顯示代碼的工程到本地。代碼地區右上方：單擊SDK文檔可查看對應版本SDK的詳細資料。單擊SDK安裝資訊可擷取對應版本和程式設計語言SDK的依賴安裝方式。