01API 的使用场景
Finger Manager API 可以用于客户数据同步、任务与工作流同步、事件通知、报表与数据导出,以及第三方模块连接。
- 客户数据同步:将企业已有系统中的客户资料同步到 Finger Manager,或将 Finger Manager 中的客户状态同步回企业内部系统。
- 任务与工作流同步:将外部系统中的运营事项同步为 Finger Manager 任务,或将 Finger Manager 的处理结果同步至外部系统。
- 事件通知:通过事件机制,让企业系统知道客户状态、KYC、任务、审核、风险、报表或权限发生变化。
- 报表与数据导出:通过 API 获取部分运营数据或报表结果,用于内部分析、管理汇总或系统归档。
- 第三方模块连接:连接 KYC 服务、客户分析工具、风险监控服务、报表系统、通知服务或内部审批系统。
02客户数据同步
客户数据同步用于将企业已有系统中的客户资料同步到 Finger Manager,或将 Finger Manager 中的客户状态同步回企业内部系统。
- 客户 ID
- 客户姓名或企业名称
- 联系方式
- 所属团队
- 所属 IB
- 账户状态
- KYC 状态
- 创建时间
- 更新时间
03任务与工作流同步
任务与工作流同步可以将外部系统中的运营事项同步为 Finger Manager 任务,或将 Finger Manager 的处理结果同步至外部系统。
- 开户申请
- KYC 审核
- 入金审核
- 出金审核
- 客服工单
- 风险事件
- 报表任务
- 权限变更申请
04事件通知
Finger Manager 可以通过事件机制,让企业系统知道某些状态发生了变化。
- 客户状态更新
- KYC 状态变更
- 任务创建
- 任务完成
- 审核通过
- 审核拒绝
- 风险事件生成
- 报表生成完成
- 权限变更
05报表与数据导出
企业可以通过 API 获取部分运营数据或报表结果,用于内部分析、管理汇总或系统归档。
- 客户统计
- KYC 统计
- 任务处理统计
- 支付审核统计
- 风险事件统计
- 团队工作量
- 操作日志摘要
06第三方模块连接
如果企业启用模块商店中的插件模块,API 可以用于连接外部服务或第三方模块。
- KYC 服务接入
- 客户分析工具
- 风险监控服务
- 报表系统
- 通知服务
- 内部审批系统
07API 访问权限
API 访问应由企业管理员或授权技术人员配置。为了保证数据安全,API 访问通常需要 API Key、Access Token、企业账户 ID、权限范围、IP 白名单、请求签名、访问日志和速率限制。具体方式取决于企业启用的模块、部署方式和安全配置。
- API Key
- Access Token
- 企业账户 ID
- 权限范围
- IP 白名单
- 请求签名
- 访问日志
- 速率限制
08身份与认证
Finger Manager API 请求需要进行身份验证。企业应妥善保管 API 凭证,不应将凭证暴露在前端代码、公开仓库、聊天工具或未经授权的环境中。如发现 API 凭证泄露,应立即停用并重新生成凭证。
- Bearer Token
- API Key
- 请求签名
- 企业级访问凭证
09数据权限范围
API 能访问的数据范围取决于企业账户配置、模块权限和 API 凭证权限。建议遵循最小权限原则,只开放系统集成所必需的权限。
- 只读客户数据
- 只读任务状态
- 允许创建任务
- 允许更新任务状态
- 允许读取报表
- 允许接收事件通知
- 限制某些敏感字段
- 限制特定团队或业务线数据
10常见 API 分类
常见 API 分类包括客户 API、KYC API、任务 API、支付审核 API、风险事件 API、报表 API 和审计日志 API。
- 客户 API:创建客户、查询客户、更新客户资料、更新客户状态、查询客户所属团队、查询客户 KYC 状态。
- KYC API:查询 KYC 状态、创建 KYC 审核任务、更新审核结果、提交补件状态、查询审核记录。
- 任务 API:创建任务、查询任务列表、查询任务详情、更新任务状态、分配任务、关闭任务、添加备注。
- 支付审核 API:创建支付审核任务、查询支付审核状态、更新审核结果、标记异常、查询支付审核记录。
- 风险事件 API:创建风险事件、查询风险事件、更新事件状态、提交复核、关闭事件、查询处理记录。
- 报表 API:创建报表任务、查询报表状态、获取报表结果、查看历史导出记录、查询统计摘要。
- 审计日志 API:查询操作日志、权限变更记录、任务处理记录、登录记录、导出记录。
11Webhook 事件
Webhook 用于将 Finger Manager 中发生的事件推送到企业指定系统。企业系统收到 Webhook 后,应验证签名、检查事件 ID,并避免重复处理同一事件。
- customer.created
- customer.updated
- kyc.status_changed
- task.created
- task.updated
- task.completed
- payment.review_created
- payment.review_updated
- risk.event_created
- risk.event_closed
- report.generated
- permission.changed
12API 安全建议
使用 API 时,建议企业遵守安全原则,保护凭证、区分环境、验证 Webhook、记录调用日志、监控异常请求,并避免传输无必要的敏感数据。
- 不在前端暴露 API Key
- 对 API 凭证设置最小权限
- 为生产环境和测试环境使用不同凭证
- 定期轮换 API 密钥
- 启用 IP 白名单
- 验证 Webhook 签名
- 记录 API 调用日志
- 对异常请求进行监控
- 不传输无必要的敏感数据
13测试与上线
在正式接入 API 前,建议明确集成目标、确认需要同步的数据类型、确认 API 权限范围、准备测试环境、使用测试数据完成联调、检查异常处理逻辑、验证 Webhook 重试机制、进行安全检查、切换至生产环境,并持续监控 API 调用状态。
- 明确集成目标
- 确认需要同步的数据类型
- 确认 API 权限范围
- 准备测试环境
- 使用测试数据完成联调
- 检查异常处理逻辑
- 验证 Webhook 重试机制
- 进行安全检查
- 切换至生产环境
- 持续监控 API 调用状态
14API 使用边界
Finger Manager API 仅用于企业内部运营管理、数据同步、系统集成和工作流协作。企业应根据自身业务、系统架构和适用法律法规,合理使用 API。
- 不应用于面向终端用户提供交易服务
- 不应用于自动做出投资建议
- 不应用于执行交易撮合
- 不应用于处理客户资金托管
- 不应用于替代企业自身的合规判断
- 不应用于绕过企业内部权限控制