應用程式界面(API)

「智方便」功能是通過RESTful應用程式界面(API)構建的,在獲得「智方便」用戶授權後,已註冊的網上服務可以使用相關應用程式界面。「智方便」參考了OAuth 2.0授權協議,為「智方便」用戶、網上服務和「智方便」系統之間進行認證及授權。採用「智方便」的網上服務需要提供RESTful回調API以接收來自「智方便」系統的API回應。

「智方便」API支援以下功能:

身份認證

通過使用身份認證API,用戶可以簡單而安全地使用「智方便」認證其身份。身份認證API適用於多種情況需要,例如eKYC解決方案、用戶登入、考勤系統、投票系統、預訂系統等。

重新認證(與身份認證API一起使用)

當用戶使用「智方便」登入網上服務後,網上服務可因應對身份認證有更嚴格規定的需要,而調用重新認證API要求有關的「智方便」用戶再以其數碼身份進行驗證。此API需要在身份認證 API - getToken 中取得存取權標。

填寫表格(與「智方便」身份認證API配合使用)

在獲得用戶同意後,網上服務可以調用填寫表格API來獲取「智方便」用戶的個人數據,包括姓名、香港身份證號碼、性別、出生日期、電話號碼等。此API可以用於協助「智方便」用戶在進行網上申請時,將用戶的個人資料自動填上。典型例子包括遙距開户、網上申請表格、身份核實和地址核實。此API需要在身份認證API - getToken中取得存取權標。

無需登入服務而進行的填寫表格(也稱為匿名填寫表格)

與填寫表格API相同,此API在得到「智方便」用戶同意的情況下,會向網上服務提供用戶的個人資料。但調用此API不需要事先取得存取權標,用戶身份認證將會在網上服務發出請求後進行。有別於身份認證API,此API中取得的存取權標無法重複使用。

數碼簽署(與「智方便」身份認證API配合使用)

網上服務可以調用數碼簽署API讓「智方便」用戶能夠在網上完成具有法律效力的數碼簽署。此API可在多種情況下使用,例如網上簽署申請表格、簽署合同和協議等。此API需要在身份認證API - getToken中取得存取權標。

無需登入服務而進行的數碼簽署(也稱為匿名簽署)

與數碼簽署API相同,此API允許「智方便」用戶網上完成具有法律保障的數碼簽署。但調用此API無需事先取得存取權標,用戶身份認證將會在網上服務發出請求後進行。有別於身份認證API,此API取得的存取權標無法重複使用。