获取营期保险金额
基于营期 ID(period_id)查询本期实际生效的保险金额:按保险逐款返回「保险名称 + 保费金额」,并给出本期保费合计、保单张数、覆盖人数。天然支持一个营期上了多款保险的场景。
本接口只读——仅查询、不落库、不改动任何数据。适用于已开通保险对接的场景;未涉及相关场景时可忽略。
POST/api/getPeriodInsurance
核心语义
- 在保口径:只统计本期**成功出单(在保)**的保单,已退保的保单不计入,因此结果即「本期当前在保的保费金额」。
- 统一保单去重:统一保单(多名营员共用同一保单号)的整团保费只按保单计一次,不会按人数重复累加,与后台开票金额口径一致,可对账。
- 多款保险分组:按「保险产品 + 计划」分组,每一款保险在
list中单独成行,各自返回名称与金额。 - 空结果:若本期无任何在保保单,
total_money/total_policy_count/total_person_count均为0、list为空数组,msg仍为空(视为查询成功的空结果)。 - 工具接口契约:
code恒为0;成功时msg为空、data为结果对象;失败时msg非空、data为空数组。
请求参数
| 名称 | 类型 | 描述 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|---|
| token | String | 身份校验令牌 | 必填 | - | 由 获取访问令牌 获得 |
| period_id | Number | 营期 ID | 必填 | - | period_id <= 0 视为未传 |
CURL
V1
curl --location --request POST 'https://open.xinduobang.cn/api/getPeriodInsurance' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'token=YOUR_TOKEN' \
--data-urlencode 'period_id=11350'
V2(appid 为 V2 版本)
curl --location --request POST 'https://open.xinduobang.cn/api/getPeriodInsurance' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-Timestamp: 1770000000' \
--header 'X-Nonce: 3f9c1a7b2e6d4058' \
--header 'X-Signature: <computed_hmac_sha256>' \
--data-urlencode 'token=YOUR_TOKEN' \
--data-urlencode 'period_id=11350'
信息
V2 签名算法及 X-Signature 计算方式见 V2 接入示例。
成功响应
{
"code": 0,
"msg": "",
"data": {
"period_id": 11350,
"total_money": 2064.00,
"total_policy_count": 3,
"total_person_count": 45,
"list": [
{
"insurance_name": "众安保险-户外拓展险(计划A)",
"insurance_product_id": "ZA000000004",
"plan_code": "ZA000000004_1",
"money": 1600.00,
"policy_count": 2,
"person_count": 40
},
{
"insurance_name": "众安保险-陆港澳旅行险(计划B)",
"insurance_product_id": "ZA000000029",
"plan_code": "ZA000000029_2",
"money": 464.00,
"policy_count": 1,
"person_count": 5
}
]
}
}
响应字段说明
| 键 | 类型 | 说明 |
|---|---|---|
| period_id | Number | 入参营期 ID |
| total_money | Number | 本期保费合计(统一保单按保单号去重后逐单累加,非按人数逐行累加) |
| total_policy_count | Number | 本期在保保单总张数 |
| total_person_count | Number | 本期覆盖营员总人数(各保单覆盖人数之和) |
| list | Array | 保险明细数组,每项一款保险(按「保险产品 + 计划」分组) |
| list[].insurance_name | String | 保险名称(含计划后缀) |
| list[].insurance_product_id | String | 保险产品 ID |
| list[].plan_code | String | 计划编码 |
| list[].money | Number | 该保金额(去重后逐保单保费之和) |
| list[].policy_count | Number | 该保保单张数 |
| list[].person_count | Number | 该保覆盖营员人数 |
失败响应
工具接口契约下
code恒为0,失败通过非空msg与空data标识。
{ "code": 0, "msg": "营期不存在period_id=11350", "data": [] }
| 错误文案 | 说明 |
|---|---|
period_id不能为空 | period_id 缺失或非法(period_id <= 0) |
营期不存在period_id=X | 对应营期不存在 |
相关接口
变更记录
| 日期 | 变更 |
|---|---|
| 2026-10-20 | 首次发布:/api/getPeriodInsurance(POST:period_id),透传上游 /Tools/getPeriodInsurance。基于营期 ID 返回本期成功出单(在保)保险的名称与金额,支持多款保险(按「保险产品 + 计划」分组);统一保单按保单号去重后一保单只计一次保费(对齐后台开票口径,避免整团保费按人数放大)。返回 total_money / total_policy_count / total_person_count / list[]。只读,不落库 |