接口设计、数据规范与接入指南

面向开发与集成团队,提供业务对象、字段结构、请求响应及联调说明,支持接入需求评估和技术方案确认。

接入设计 v0.1

当前为接入方案与本地演示资料。真实业务接口暂未开放,地址、认证、字段与能力范围将在正式接入时确认。

业务接口结构

以下路径与字段用于需求讨论,不是已部署的服务地址。正式接入前需要逐项确认协议与业务含义。

GET/v1/benefits

权益目录查询

智优权益中台系统:用于展示权益标识、分类与使用说明。

GET/v1/points/ledger

积分流水查询

智悠积分商城中台:用于说明账户标识、积分变动与业务关联。

POST/v1/compute/messages

智能应用请求

智云算力聚合中枢:用于讨论模型选择、输入内容与响应结构。

输入字段说明

字段类型使用条件说明
business_ref / request_idstring调用方的业务追踪编号;示例工具只接受字母、数字、下划线和短横线。
pageinteger查询时页码,从 1 开始;具体分页方式在接口确认阶段约定。
page_sizeinteger查询时单页数量;正式上限与默认值由实际接口规范确定。
modelstring算力示例模型标识占位,正式取值以获准接入范围为准。
messagesarray算力示例角色与文本的输入集合;本例仅展示普通虚构内容。
streamboolean算力示例是否请求流式输出;本地示例固定为 false。

统一响应与错误说明

字段含义
code业务处理结果标识,示例使用 OK;正式枚举需在接入时确认。
message供调用方理解的简短说明;不应替代业务状态判断。
request_id追踪一次请求或业务处理的编号,便于联调与定位。
data对应业务的数据对象,不同接口使用不同结构。

参数不符合约定

检查必填、格式与枚举。修正参数后再发起请求,避免无效重复重试。

重复或处理中

通过业务唯一编号查询已有结果,先确认状态,避免重复创建或发放。

超时或暂不可用

区分网络与业务结果,按约定重试与查询;具体上限在真实接入时确定。

回调与状态衔接

需要异步处理的业务,应把“请求受理”与“业务完成”区分开。回调只是一种状态通知方式,接收方仍需核验来源并避免重复处理。

  • 为事件与业务对象分别保留唯一编号
  • 认证与验签方式在正式接入阶段约定
  • 重复事件不重复发放或更新账户
  • 必要时通过查询接口核对最终状态
  • 回调失败、补发与保留时间按实际协议确认
回调结构示例 · JSON
{
  "event_id": "demo_event_001",
  "event_type": "benefit.status.changed",
  "business_ref": "demo_business_001",
  "occurred_at": "2026-09-14T08:00:00Z",
  "data": {
    "order_id": "demo_order_001",
    "status": "completed"
  },
  "note": "设计示例,不代表正式业务回调"
}

咨询接口与系统集成方案

提供应用类型、业务对象、数据流向与接口需求,确认接入范围、联调计划及验收要求。

商务咨询