获取开放应用信息 #
描述 #
使用此接口获取开放应用的状态、基础信息、认证信息。
接口说明 #
授权对象 ISVAPP
请求地址 GET /open/app/app
请求规则 请查阅开发必读
请求参数 #
| 参数名称 | 变量名称 | 参数类型[长度限制] | 是否必填 | 描述 |
|---|---|---|---|---|
| AppID | appId | string[1, 32] | 条件选填 | query此参数为应用唯一标识，若授权对象为ISV则此项必填，若授权对象为APP则此项不校验且以HTTP Header内信息为准。示例值：Zc3SsV49OHVG0uB9 |
响应结果 #
| 参数名称 | 变量名称 | 参数类型[长度限制] | 是否必填 | 描述 |
|---|---|---|---|---|
| 应用信息 | app | object | 否 | |
| 能力列表 | abilityList | []object | 否 |
应用信息 app #
| 参数名称 | 变量名称 | 参数类型[长度限制] | 是否必填 | 描述 |
|---|---|---|---|---|
| 应用名称 | title | string[1, 64] | 是 | 开放应用名称，是开放应用的标识信息。 示例值：BOOL不二云微 |
| 应用LOGO | thumb | string[1, 255] | 否 | 示例值：https://boolc.oss-cn-chengdu.aliyuncs.com/image/20210512/f5055e0e-cdc5-43f1-b332-9b5f0c731511.png?x-oss-process=image/interlace,1/resize,m_lfit,w_800,h_800/quality,q_100 |
| 应用状态 | status | int8 | 是 | 1 正常应用 2 黑名单应用。 示例值：1 |
| 应用余额 | balance | float64 | 是 | 单位：元 示例值：12.08 |
| 企业认证信息 | subjectInfo | object | 否 | 通过设置应用信息进行填写。 |
企业认证信息 subjectInfo #
| 参数名称 | 变量名称 | 参数类型[长度限制] | 是否必填 | 描述 |
|---|---|---|---|---|
| 企业名称 | companyName | string[1, 64] | 是 | 示例值：贵州不二云科技有限公司 |
| 证件图片 | companyLicense | string[1, 255] | 是 | 请填写通过文件上传接口返回的key。 示例值：image/20210512/f5055e0e-cdc5-43f1-b332-9b5f0c731511.png |
| 执照编号 | companyLicenseNo | string[1, 255] | 是 | 示例值：91520102MA6GK9HM4P |
| 联系人 | contact | string[1, 16] | 是 | 示例值：布尔 |
| 联系电话 | mobile | string[1, 32] | 是 | 示例值：13024777828 |
| 省份 | province | string[1, 32] | 是 | 示例值：贵州 |
| 城市 | city | string[1, 32] | 是 | 示例值：贵阳 |
| 地址 | companyAddress | string[1, 64] | 是 | 示例值：黔中大道贵安数字小镇 |
能力列表 abilityList #
| 参数名称 | 变量名称 | 参数类型[长度限制] | 是否必填 | 描述 |
|---|---|---|---|---|
| 能力ID | id | uint32 | 是 | 此参数为能力的唯一标识。 示例值：1 |
| 能力名称 | title | string[1, 32] | 是 | 示例值：骑手保险 |
| 能力介绍 | desc | text | 是 | 此参数为能力的概要说明，类型为富文本。 |
| 能力类别 | code | int8 | 是 | 此参数为能力的类别标识。1 保险业务 示例值：1 |
| 能力状态 | status | int8 | 是 | 1 待签约 2 签约中 3 已生效 4 签约失败 5 已失效。 示例值：3 |
| 续签状态 | signStatus | int8 | 是 | 0 未续签 1 自动续签中。 示例值：1 |
| 续签时间 | expireAt | int64 | 是 | 即签约过期时间，需在此时间五天内进行续签操作。 示例值：1626610000 |
| 签约单价 | price | float64 | 否 | 若暂时没有价格或免费情况下不返回此数据值。 示例值：3.8 |
| 独立账户余额 | balance | float64 | 否 | 若暂时没有则不显示，部分能力有独立余额需要显示。 示例值：300 |
| 价格单位 | unit | string[1, 32] | 否 | 若暂时没有价格或免费情况下不返回此数据值。 示例值：元/天/人 |
| 签约说明 | message | string[1, 255] | 是 | 此参数是本能力的签约说明，如被驳回的信息、签约能力的问题。 示例值：您的签约请求被驳回，原因：营业执照不清晰。 |
| 附加信息 | ext | object | 否 | 详见下方 |
附加信息 ext #
| 参数名称 | 变量名称 | 参数类型[长度限制] | 是否必填 | 描述 |
|---|---|---|---|---|
| 第三方价格 | transationPrice | float64 | 否 | 若第三方价格和应用服务费分开收，会返回此字段。 示例值：3 |
| 应用服务额度 | srvTimes | unit | 否 | 计算当前应用在此能力中剩余可用次数。 示例值：50 |
| 独立账户额度 | balanceTimes | unit | 否 | 计算当前应用在此能力中剩余可用次数。 示例值：50 |
响应示例 #
> 200 Response
{
"code": 20000,
"msg": "success",
"data": {
"abilityList": [
{
"id": 1,
"code": 1,
"desc": "由中国平安保险承保的雇主责任保险（A款）。此能力签约生效后可为骑手投保，每日22点前确认名单次日0点自动生效投保。",
"message": "",
"price": 3.8,
"status": 0,
"signStatus": 1,
"expireAt": 1626610000,
"title": "骑手保险",
"unit": "元/天/人"
}
],
"app": {
"balance": 0,
"status": 1,
"subjectInfo": {
"companyLicense": "https://p.boolc.cn/image/20210713/ad411f8b-23ff-4a0d-a403-b580466b12a1.png?imageView2/2/w/800/h/800/q/100&e=1626254403&token=eAvZ-185O6s8bEwY1vZw3Rfny6go5jfnq1oLaUdP:c0f75fD1T1LRI_IAOCrASzMhXPk=",
"companyName": "贵州不二云科技有限公司",
"companyLicenseNo": "91520102MA6GK9HM4P",
"mobile": "13024777828"
},
"thumb": "https://boolc.oss-cn-chengdu.aliyuncs.com/image/20210513/46e1a7de-95ab-4b92-bcac-98d4554678d2.png?x-oss-process=image/interlace,1/resize,m_lfit,w_300,h_300/quality,q_100",
"title": "BOOL不二云微"
}
}
}