跳到主要内容

快速开始

简介

「智方便」为公私营机构提供了有关身份认证、表格填写和数码签署功能的应用程式介面(API),让他们在提供网上服务时采用「智方便」。本指南将提供详细指引,说明在不同的业务场景中如何采用「智方便」API:

  • 身份核实 在业务营运中当需要验证客户身份时,您可以在身份核实流程中采用「智方便」,使用其无需登入服务而可进行填写表格API
  • 遥距开户 : 「智方便」的无需登入服务而可进行的填写表格API,让客户可以使用其提供的已验证个人资料,在网上完成开立户口流程。
  • 登入服务 : 在将「智方便」户口与您的网上服务建立联系后,客户可以使用「智方便」登入而无需密码。使用身份认证API。
  • 使用「智方便」登入后的数码签署 : 在使用「智方便」登入网上服务后,持有「智方便+」户口的客户可以使用数码签署API,方便而安全地遥距签署数码文件。
  • 无需登入服务的数码签署 : 有时候,业务运作上并不需要先登入服务,在此情况下,您的网上服务可以要求客户使用「智方便+」户口进行数码签署。无需登入服务而进行的数码签署API

先决条件

在测试环境(即ITE环境)中使用「智方便」API进行测试,您的网上服务必须进入第2阶段设计(连结采用起始的设计)。为了准备ITE设定环境并开始开发,您需要具备以下先决条件:

  • 网上服务伺服器
  • 网上服务凭证(客户端识别码和客户端密钥)
  • 自助服务入门网站的创建者和审批者户口
  • 「智方便」测试应用程式和支援团队发放的测试户口
  • 加密证书
  • 公开IP与域名及伺服器证书(TLS1.2或以上)

内容加密

除了在「智方便」和您的网上服务之间的所有HTTPS通讯中启用SSL/TLS加密之外,在与「智方便」进行通讯的所有API POST请求(除了请求取得对称加密密钥的网上服务)中还应用了额外的数据加密层,目的就是为了要将传输中的数据保护得更好。由「智方便」系统生成的对称加密密钥称为内容加密密钥(CEK),在一段特定时间内有效。当CEK过期或发生异常时,您的网上服务需要请求取得最新的CEK。CEK由您网上服务的加密证书的公钥加密,该加密证书的公钥称为加密证书的公钥(KEK)。因此,您需要将KEK上传到自助服务入门网站。

自助服务入门网站设置

网上服务提供者需要通过自助服务入门网站在「智方便」系统中设置网上服务配置。该配置应包括加密证书和所需的回调URL。

自助服务入门网站管理员设置和户口管理

网上服务提供者需要为每个网上服务指派一个管理员,以管理接达自助服务入门网站的访问。管理员负责户口管理工作。管理员需要为网上服务创建网上服务创建者和审批者的使用者户口。

自助服务入门网站回调URL的配置

为了取得从「智方便」伺服器的回应中收到的业务参数,需要在自助服务入门网站中设置所需的回调URL。

自助服务入门网站加密证书(KEK证书)的配置

每个网上服务需要上传一个加密证书的公钥,使到利用「智方便」系统进行的讯息传输获得额外安全保障。「智方便」系统只会接受获香港承认的认证机构(RCA)所颁发的证书。

测试应用程式的安装和设置

只有获授权用户才能下载测试应用程式。申请时请更新ITE申请表。

  • iOS用户将收到一封包含TestFlight兑换代码的邀请电邮。
  • Android用户请到App Store下载应用程式。