1. 接口描述
接口请求域名:
iot.cloud.tencent.com/api/exploreropen/serviceapi
。
本接口(ServiceGetInsurancePageURL)用于获取保险领取页面地址。2. 输入参数
名称 | 类型 | 必选 | 描述 |
Action | String | 是 | 公共参数,本接口取值:ServiceGetInsurancePageURL。 |
RequestId | String | 是 | 公共参数,唯一请求 ID,可自行生成,推荐使用 uuId。定位问题时,需提供该次请求的 RequestId。 |
AppKey | String | 是 | 公共参数,物联网 SaaS 的 AppKey ,用于标识对应的物联网 SaaS。 |
Signature | String | 是 | 公共参数,请求签名,需用户自行生成,用于校验请求的合法性。 |
Timestamp | Int64 | 是 | 公共参数,请求的 Unix 时间戳(秒级)。 |
Nonce | Int | 是 | 公共参数,随机正整数,与 Timestamp 联合起来,防止重放攻击。 |
CustomerId | String | 是 | 厂商应用端的唯一用户 ID。 |
ItemId | String | 是 | 订单下的服务类型。 FireInsurance2020:物联网火灾安全保障服务-正式 。 D-FireInsurance2020:物联网火灾安全保障服务-测试。 CarInsurance2021:物联网两轮车安全保障服务-正式。 D-CarInsurance2021:物联网两轮车安全保障服务-测试。 说明:正式单会消耗授权数,服务发布后才可选用;测试单不会消耗授权数,在保险领取页面领取的 是无效保单,供调试使用,服务发布前后均可用。 |
ItemVNO | String | 是 | 订单下的服务版本。 以下为物联网火灾安全保障服务版本: FireBusiness:商业版。 FireMER20W:商户企业园区版20w。 FireMER50W:商户企业园区版50w。 FireMER100W:商户企业园区版100w。 FirePRO20W :生产园区版20w。 FirePRO50W:生产园区版50w。 FirePRO100W:生产园区版100w。 以下为物联网两轮车安全保障服务版本: AutoBase:基础版。 AutoUpgrade:升级版。 AutoVIP:无忧版。 |
3. 输出参数
名称 | 类型 | 描述 |
RequestId | String | 公共参数,唯一请求 ID,与入参相同,定位问题时,需提供该次请求的 RequestId。 |
URL | String | 领取页面 H5 地址。 注意: 当订单为测试单或者订单为物联网火灾安全保障服务正式单-商业版时,请使用 H5 地址作为保险领取页。 当订单为其他类型的正式单时,请使用 MpAppId 和 MpAppPath 作为保险领取页,才可以正常进入投保流程。 |
MpAppId | String | 领取页面-腾讯连连小程序 APPID。 |
MpAppPath | String | 领取页面-腾讯连连小程序跳转路径。 |
4. 示例
输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/serviceapi HTTP/1.1content-type: application/json{"RequestId": "f92406b3-****-4fe8-bc43-45e3d794bb68","Timestamp": 1599468019,"Nonce": 170533123,"AppKey": "AppKey","Signature": "Signature","Action": "ServiceGetInsurancePageURL","CustomerId": "Customer100001","ItemId": "FireInsurance2020","ItemVNO": "FireMER20W"}
输出示例:成功
{"Response": {"RequestId": "f92406b3-****-4fe8-bc43-45e3d794bb68","URL": "https://www.example.com/path/to/h5homepage?CustomerId=abc&ServiceAppKey=xyz&ItemId=FireInsurance2020&ItemVNO=FireBusiness","MpAppId": "WX123","MpAppPath": "/IOT/JUMPPATH"}}
输出示例:失败
{"Response": {"Error": {"Code": "InvalidParameterValue","Message": "Signature 无效"},"RequestId": "f92406b3-****-4fe8-bc43-45e3d794bb68"}}
5. 错误码
错误码 | 描述 |
InternalError | 内部错误。 |
ErrorRequiredParamNotFound | 必选参数缺失。 |
InvalidAction | Action 非法。 |
InvalidParameterValue | 参数非法。 |
InvalidParameterValue.InvalidJSON | 请求格式不是 JSON。 |