跳转到主要内容
适用于 Ruby 的 Didit 官方 gem。需要 Ruby 3.1 或更高版本,并使用标准库中的 net/http。各 SDK 的共同内容,请参阅服务端 SDK 概览。

安装

该 gem 为 RubyGems 上的 didit-sdk。其源代码和变更日志位于 GitHub 上的 didit-protocol/sdk-ruby。 或者,将 gem "didit-sdk" 添加到您的 Gemfile 中,然后运行 bundle install。使用 require "didit" 加载。

配置客户端

Didit::Client.new 会从环境变量中读取 DIDIT_API_KEY。如需覆盖该值,或设置应用级调用(案件、网络、监管报告)所需的组织和应用 ID,请传入关键字参数。请求字段是使用 API 原有名称的关键字参数;响应则是对象,每个字段都有对应的读取方法,并支持 [:field] 和 to_h。

创建会话

为某个工作流创建验证会话,然后将用户引导至该会话的 URL。

读取决策

用户完成验证后(或 Webhook 到达时),读取决策。每个功能结果都是一个列表,每个工作流节点对应一个条目。

验证 Webhook

传入原始请求体(按接收时的原样)以及请求头。对于任何无效或过期的投递,verify 都会抛出 Didit::WebhookVerificationError;否则返回带类型的事件。
在 Rails 中,调用 handle_webhook(request.raw_post, request.headers)。轮换密钥期间,请同时传入两者:[new_secret, old_secret]。事件和签名方案详见 Webhooks。

筛查交易

将支付、提现或加密货币转账提交至交易监控;响应中包含其状态和风险评分。

验证 Authentication token

Didit::Authentication 会在您的后端检查您的 Authentication 颁发方签名的访问 token,无需为每个请求调用 Didit。它还可以交换授权码、刷新 token、检查和撤销会话,以及执行升级验证。
token 验证会根据您应用的颁发方和签名密钥,执行在您的服务器上验证 token 中描述的检查。

错误

列表和文件

API 参考 中的服务端端点页面都为其操作提供了 Ruby 示例,但 1.0.1 版本尚未支持的端点和字段除外,这些内容在概览中有说明。
最后修改于 2026年11月7日