> For the complete documentation index, see [llms.txt](https://docs-cn.multimarkets.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-cn.multimarkets.org/client-api/geng-duo-.../ke-hu-jie-kou-ke-hu-kai-fang-api.md). # 客户接口/客户开放API ## 申请API > version=0.0.1\ > bizType=customer.app.CustomerApiWebService.applyApi\ > 登录之后可以访问 ```json {"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"客户接口/客户开放API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.applyApi":{"post":{"summary":"申请API","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.applyApi\n登录之后可以访问","operationId":"applyApi","tags":["客户接口/客户开放API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tag":{"type":"string","description":"API标签"},"googleCode":{"type":"string","description":"谷歌验证码"},"phoneCode":{"type":"string","description":"手机验证码、邮箱验证一个必填"},"emailCode":{"type":"string","description":"手机验证码、邮箱验证一个必填"},"phoneSendToken":{"type":"string","description":"发送手机验证码返回token,phoneCode不为空时必传"},"emailSendToken":{"type":"string","description":"发送邮箱验证码返回token,emailCode不为空时必传"}},"required":["tag"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"type":"object","properties":{"bizCode":{"type":"string","description":"模块标识码"},"code":{"type":"string","description":"状态返回码"},"msg":{"type":"string","description":"状态描述"},"tm":{"type":"integer","format":"int64","description":"处理时长（毫秒）"},"trace":{"type":"string","description":"跟踪码"},"msgParams":{"type":"string","description":"返回描述中占位符参数串，多个参数间以,分割"},"data":{"type":"object","description":"数据体","properties":{}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}}} ``` ## 删除API > version=0.0.1\ > bizType=customer.app.CustomerApiWebService.delApi\ > 登录之后可以访问 ```json {"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"客户接口/客户开放API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.delApi":{"post":{"summary":"删除API","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.delApi\n登录之后可以访问","operationId":"delApi","tags":["客户接口/客户开放API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"api的id"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"type":"object","properties":{"bizCode":{"type":"string","description":"模块标识码"},"code":{"type":"string","description":"状态返回码"},"msg":{"type":"string","description":"状态描述"},"tm":{"type":"integer","format":"int64","description":"处理时长（毫秒）"},"trace":{"type":"string","description":"跟踪码"},"msgParams":{"type":"string","description":"返回描述中占位符参数串，多个参数间以,分割"},"data":{"type":"object","description":"数据体","properties":{}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}}} ``` ## 分配权限 > version=0.0.1\ > bizType=customer.app.CustomerApiWebService.editApiPermission\ > 登录之后可以访问 ```json {"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"客户接口/客户开放API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.editApiPermission":{"post":{"summary":"分配权限","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.editApiPermission\n登录之后可以访问","operationId":"editApiPermission","tags":["客户接口/客户开放API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"api的ID"},"googleCode":{"type":"string","description":"谷歌验证码"},"tag":{"type":"string","description":"API标签，不能重复"},"permissionList":{"type":"array","description":"开启权限","items":{"type":"object","properties":{"code":{"type":"string","description":"权限code"},"status":{"type":"integer","format":"int32","description":"是否开启 1.开启 2.关闭"}},"required":["status"]}},"whiteIps":{"type":"string","description":"白名单IP，绑定的ip地址，以，分割"},"phoneCode":{"type":"string","description":"手机验证码、邮箱验证一个必填"},"emailCode":{"type":"string","description":"手机验证码、邮箱验证一个必填"},"phoneSendToken":{"type":"string","description":"发送手机验证码返回token,phoneCode不为空时必传"},"emailSendToken":{"type":"string","description":"发送邮箱验证码返回token,emailCode不为空时必传"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResult1":{"type":"object","properties":{"bizCode":{"type":"string","description":"模块标识码"},"code":{"type":"string","description":"状态返回码"},"msg":{"type":"string","description":"状态描述"},"tm":{"type":"integer","format":"int64","description":"处理时长（毫秒）"},"trace":{"type":"string","description":"跟踪码"},"msgParams":{"type":"string","description":"返回描述中占位符参数串，多个参数间以,分割"},"data":{"type":"object","description":"数据体","properties":{}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}}} ``` ## API列表 > version=0.0.1\ > bizType=customer.app.CustomerApiWebService.page\ > 登录之后可以访问 ```json {"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"客户接口/客户开放API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.page":{"post":{"summary":"API列表","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.page\n登录之后可以访问","operationId":"page","tags":["客户接口/客户开放API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"size":{"type":"integer","format":"int64","description":"每页条数"},"current":{"type":"integer","format":"int64","description":"当前页"},"tag":{"type":"string","description":"API标签"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","description":"模块标识码"},"code":{"type":"string","description":"状态返回码"},"msg":{"type":"string","description":"状态描述"},"tm":{"type":"integer","format":"int64","description":"处理时长（毫秒）"},"trace":{"type":"string","description":"跟踪码"},"msgParams":{"type":"string","description":"返回描述中占位符参数串，多个参数间以,分割"},"data":{"type":"object","properties":{"records":{"type":"array","description":"结果列表","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"该api对应的唯一ID"},"createTime":{"type":"integer","format":"int64","description":"创建时间/申请时间"},"updateTime":{"type":"integer","format":"int64","description":"更新时间"},"apiKey":{"type":"string","description":"access Key"},"customerNo":{"type":"string","description":"customerNo"},"customerId":{"type":"integer","format":"int64","description":"客户ID"},"customerGroupId":{"type":"integer","format":"int64","description":"客户组ID"},"companyId":{"type":"integer","format":"int64","description":"companyId"},"secretKeyMd5":{"type":"string","description":"secretKeyMd5"},"privateKey":{"type":"string","description":"secretKey,只有申请时才返回"},"pubKey":{"type":"string","description":"公钥"},"tag":{"type":"string","description":"标签"},"permissionDTOList":{"type":"array","description":"权限列表","items":{"$ref":"#/components/schemas/CustomerApiPermissionDTO"}},"ipLimit":{"type":"boolean","description":"是否开启了IP限制"},"whiteIps":{"type":"string","description":"IP白名单"},"sources":{"type":"array","description":"允许访问的权限路径","items":{"type":"string"}},"expiredTime":{"type":"integer","format":"int64","description":"失效时间"},"withdrawTime":{"type":"integer","format":"int64"},"validityDays":{"type":"integer","format":"int32","description":"有效期（天） -1 已失效 null 永久有效，"}}}},"total":{"type":"integer","format":"int64","description":"总数"},"size":{"type":"integer","format":"int64","description":"每页条数"},"current":{"type":"integer","format":"int64","description":"当前页"}}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}},"components":{"schemas":{"CustomerApiPermissionDTO":{"type":"object","required":["status"],"properties":{"code":{"type":"string","description":"权限code"},"name":{"type":"string","description":"权限名称"},"status":{"type":"integer","format":"int32","description":"是否开启 1.开启 2.关闭"},"canEdit":{"type":"boolean","description":"是否可以编辑"},"paths":{"type":"array","description":"权限路径","items":{"type":"string"}}}}}}} ``` ## API详情 > version=0.0.1\ > bizType=customer.app.CustomerApiWebService.queryApi\ > 登录之后可以访问 ```json {"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"客户接口/客户开放API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.queryApi":{"post":{"summary":"API详情","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.queryApi\n登录之后可以访问","operationId":"queryApi","tags":["客户接口/客户开放API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"API的Id"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultCustomerApiVO"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResultCustomerApiVO":{"type":"object","properties":{"bizCode":{"type":"string","description":"模块标识码"},"code":{"type":"string","description":"状态返回码"},"msg":{"type":"string","description":"状态描述"},"tm":{"type":"integer","format":"int64","description":"处理时长（毫秒）"},"trace":{"type":"string","description":"跟踪码"},"msgParams":{"type":"string","description":"返回描述中占位符参数串，多个参数间以,分割"},"data":{"$ref":"#/components/schemas/CustomerApiVO"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"CustomerApiVO":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"id"},"createTime":{"type":"integer","format":"int64","description":"创建时间/申请时间"},"updateTime":{"type":"integer","format":"int64","description":"更新时间"},"apiKey":{"type":"string","description":"access Key"},"customerNo":{"type":"string","description":"customerNo"},"customerId":{"type":"integer","format":"int64","description":"客户ID"},"customerGroupId":{"type":"integer","format":"int64","description":"客户组ID"},"companyId":{"type":"integer","format":"int64","description":"companyId"},"secretKeyMd5":{"type":"string","description":"secretKeyMd5"},"privateKey":{"type":"string","description":"secretKey,只有申请时才返回"},"pubKey":{"type":"string","description":"公钥"},"tag":{"type":"string","description":"标签"},"permissionDTOList":{"type":"array","description":"权限列表","items":{"$ref":"#/components/schemas/CustomerApiPermissionDTO"}},"ipLimit":{"type":"boolean","description":"是否开启了IP限制"},"whiteIps":{"type":"string","description":"IP白名单"},"sources":{"type":"array","description":"允许访问的权限路径","items":{"type":"string"}},"expiredTime":{"type":"integer","format":"int64","description":"失效时间"},"withdrawTime":{"type":"integer","format":"int64"},"validityDays":{"type":"integer","format":"int32","description":"有效期（天） -1 已失效 null 永久有效，"},"nextTag":{"type":"string","description":"下期续费标签"},"times":{"type":"string","description":"套餐时长类型。month－月；year－年；quarter－一季；half－半年；"},"nextTimes":{"type":"string","description":"下期续费套餐时长类型。month－月；year－年；quarter－一季；half－半年；"},"amountMonth":{"type":"string","description":"续费套餐月金额（单位USDT）"},"amountYear":{"type":"string","description":"续费套餐月金额（单位USDT）"}}},"CustomerApiPermissionDTO":{"type":"object","required":["status"],"properties":{"code":{"type":"string","description":"权限code"},"name":{"type":"string","description":"权限名称"},"status":{"type":"integer","format":"int32","description":"是否开启 1.开启 2.关闭"},"canEdit":{"type":"boolean","description":"是否可以编辑"},"paths":{"type":"array","description":"权限路径","items":{"type":"string"}}}}}}} ``` ## 降级API套餐 > version=0.0.1\ > bizType=customer.app.CustomerApiWebService.downgrade\ > 登录之后可以访问 ```json {"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"客户接口/客户开放API"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.CustomerApiWebService.downgrade":{"post":{"summary":"降级API套餐","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerApiWebService.downgrade\n登录之后可以访问","operationId":"applyApi","tags":["客户接口/客户开放API"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"apiKey":{"type":"string","description":"客户ApiKey"},"tag":{"type":"string","description":"API标签"},"times":{"type":"string","description":"套餐时长类型。month－月；year－年；quarter－一季；half－半年；"}},"required":["tag","apiKey","times"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultCustomerApiVO"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResultCustomerApiVO":{"type":"object","properties":{"bizCode":{"type":"string","description":"模块标识码"},"code":{"type":"string","description":"状态返回码"},"msg":{"type":"string","description":"状态描述"},"tm":{"type":"integer","format":"int64","description":"处理时长（毫秒）"},"trace":{"type":"string","description":"跟踪码"},"msgParams":{"type":"string","description":"返回描述中占位符参数串，多个参数间以,分割"},"data":{"$ref":"#/components/schemas/CustomerApiVO"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"CustomerApiVO":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"id"},"createTime":{"type":"integer","format":"int64","description":"创建时间/申请时间"},"updateTime":{"type":"integer","format":"int64","description":"更新时间"},"apiKey":{"type":"string","description":"access Key"},"customerNo":{"type":"string","description":"customerNo"},"customerId":{"type":"integer","format":"int64","description":"客户ID"},"customerGroupId":{"type":"integer","format":"int64","description":"客户组ID"},"companyId":{"type":"integer","format":"int64","description":"companyId"},"secretKeyMd5":{"type":"string","description":"secretKeyMd5"},"privateKey":{"type":"string","description":"secretKey,只有申请时才返回"},"pubKey":{"type":"string","description":"公钥"},"tag":{"type":"string","description":"标签"},"permissionDTOList":{"type":"array","description":"权限列表","items":{"$ref":"#/components/schemas/CustomerApiPermissionDTO"}},"ipLimit":{"type":"boolean","description":"是否开启了IP限制"},"whiteIps":{"type":"string","description":"IP白名单"},"sources":{"type":"array","description":"允许访问的权限路径","items":{"type":"string"}},"expiredTime":{"type":"integer","format":"int64","description":"失效时间"},"withdrawTime":{"type":"integer","format":"int64"},"validityDays":{"type":"integer","format":"int32","description":"有效期（天） -1 已失效 null 永久有效，"},"nextTag":{"type":"string","description":"下期续费标签"},"times":{"type":"string","description":"套餐时长类型。month－月；year－年；quarter－一季；half－半年；"},"nextTimes":{"type":"string","description":"下期续费套餐时长类型。month－月；year－年；quarter－一季；half－半年；"},"amountMonth":{"type":"string","description":"续费套餐月金额（单位USDT）"},"amountYear":{"type":"string","description":"续费套餐月金额（单位USDT）"}}},"CustomerApiPermissionDTO":{"type":"object","required":["status"],"properties":{"code":{"type":"string","description":"权限code"},"name":{"type":"string","description":"权限名称"},"status":{"type":"integer","format":"int32","description":"是否开启 1.开启 2.关闭"},"canEdit":{"type":"boolean","description":"是否可以编辑"},"paths":{"type":"array","description":"权限路径","items":{"type":"string"}}}}}}} ```