业务系统开发文档>模块开发文档

quot;zh-cn": { add: "添加", }, "zh-hk": { add: "添加", }, "en-us": { add: "Add", }, }; const DEFAULT_LANG = localStorage.getItem("backLang") || "zh-cn"; window.module_lang = module_lang[DEFAULT_LANG];})(); 具体参考idcsmart_common模块四.路由注意：方法只有登录验证，其他鉴权需要开发者自己处理具体使用可以参考mf_dcim模块五.系统方法和参数方法在模块主文件里实现，主文件类名和文件名一致 1.模块基础信息 metaData模块必须实现该方法例子:public function metaData(){return ['display_name'=>'DCIM(自定义配置)', 'version'=>'1.0.4'];} 参数:无返回: string display_name 模块名称string version 版本号 2.第一次使用模块创建该接口后 afterCreateFirstServer按需实现该方法,通常该方法用于添加模块需要的数据表模块表名建议idcsmart_module_+模块目录+具体,如idcsmart_module_mf_dcim_model_config_option_link 例子:public function afterCreateFirstServer(){$sql = ["CREATE TABLE `idcsmart_module_mf_dcim_model_config_option_link` ( `model_config_id` int(11) unsigned NOT NULL DEFAULT '0' COMMENT 'dcim型号配置id', `option_id` int(11) unsigned NOT NULL DEFAULT '0' COMMENT '可选配optionID', `option_rel_type` tinyint(7) unsigned NOT NULL DEFAULT '0' COMMENT 'option表的rel_type', KEY `idx_model_config_id` (`model_config_id`) USING BTREE) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='型号配置可选配置表';",];foreach($sql as $v){Db::execute($v);}} 参数:无返回:无 3.删除最后一个使用该模块的接口 afterDeleteLastServer按需实现该方法,通常该方法用于删除模块添加的数据表例子:public function afterDeleteLastServer(){$sql = ['drop table `idcsmart_module_mf_dcim_model_config_option_link`;',];foreach($sql as $v){Db::execute($v);}} 参数:无返回:无 4.测试连接 testConnect建议实现该方法,通常使用该方法来测试和三方接口的连接状态是否可用使用位置: 后台-商品管理-接口管理页面接口名称前面的状态例子:public function testConnect($param){$res = [ 'status' => 200, 'msg' => '连接成功',];return $res;} 参数:ServerModel param.server 当前接口ServerModel,可直接获取相关接口参数返回:int status 状态(200=成功,400=失败)string msg 信息 5.产品模块开通 createAccount建议实现该方法,当产品自动开通或者在产品内页开通会调用该方法注意: 如果未实现该方法，开通时默认会成功例子:public function createAccount($param){$res = [ 'status' => 200, 'msg' => '开通成功',];return $res;} 参数:HostModel param.host 当前产品HostModel,可获取产品相关参数ClientModel param.client 当前产品所属用户ClientModel,可获取产品所属用户相关参数ProductModel param.product当前产品所属商品ProductModel,可获取产品对应商品相关参数ServerModel param.server 当前产品关联接口ServerModel,可获取关联接口相关参数返回:int status 状态(200=成功,400=失败)string msg 信息 6.产品模块暂停 suspendAccount建议实现该方法,当产品到期或其他原因暂停或者在产品内页暂停会调用该方法注意: 如果未实现该方法，暂停时默认会成功例子:public function suspendAccount($param){$res = [ 'status' => 200, 'msg' => '暂停成功',];return $res;} 参数:HostModel param.host 当前产品HostModel,可获取产品相关参数ClientModel param.client 当前产品所属用户ClientModel,可获取产品所属用户相关参数ProductModel param.product当前产品所属商品ProductModel,可获取产品对应商品相关参数ServerModel param.server 当前产品关联接口ServerModel,可获取关联接口相关参数string param.suspend_type 暂停类型(overdue=到期暂停,overtraffic=超流暂停,certification_not_complete=实名未完成,other=其他,downstream=下游暂停)string param.suspend_reason 暂停原因返回:int status 状态(200=成功,400=失败)string msg 信息 7.产品模块解除暂停 unsuspendAccount建议实现该方法,当产品解除暂停会调用该方法注意: 如果未实现该方法，解除暂停时默认会成功例子:public function unsuspendAccount($param){$res = [ 'status' => 200, 'msg' => '解除暂停成功',];return $res;} 参数:HostModel param.host 当前产品HostModel,可获取产品相关参数ClientModel param.client 当前产品所属用户ClientModel,可获取产品所属用户相关参数ProductModel param.product当前产品所属商品ProductModel,可获取产品对应商品相关参数ServerModel param.server 当前产品关联接口ServerModel,可获取关联接口相关参数返回:int status 状态(200=成功,400=失败)string msg 信息 8.产品模块删除 terminateAccount建议实现该方法,当产品模块删除时会调用该方法注意: 如果未实现该方法，删除时默认会成功例子:public function terminateAccount($param){$res = [ 'status' => 200, 'msg' => '删除成功',];return $res;} 参数:HostModel param.host 当前产品HostModel,可获取产品相关参数ClientModel param.client 当前产品所属用户ClientModel,可获取产品所属用户相关参数ProductModel param.product当前产品所属商品ProductModel,可获取产品对应商品相关参数ServerModel param.server 当前产品关联接口ServerModel,可获取关联接口相关参数返回:int status 状态(200=成功,400=失败)string msg 信息 9.产品续费后调用 renew建议实现该方法,当产品续费后会调用该方法例子:public function renew($param){// 续费逻辑} 参数:HostModel param.host 当前产品HostModel,可获取产品相关参数ClientModel param.client 当前产品所属用户ClientModel,可获取产品所属用户相关参数ProductModel param.product当前产品所属商品ProductModel,可获取产品对应商品相关参数ServerModel param.server 当前产品关联接口ServerModel,可获取关联接口相关参数返回:无 10.升降级配置项后调用 changePackage按需实现该方法,当产品升降级配置项后会调用该方法例子:public function changePackage($param){// 具体逻辑} 参数:HostModel param.host 当前产品HostModel,可获取产品相关参数ClientModel param.client 当前产品所属用户ClientModel,可获取产品所属用户相关参数ProductModel param.product当前产品所属商品ProductModel,可获取产品对应商品相关参数ServerModel param.server 当前产品关联接口ServerModel,可获取关联接口相关参数返回:无 11.升降级商品后调用 changeProduct按需实现该方法,当产品升降级商品后会调用该方法例子:public function changeProduct($param){// 具体逻辑} 参数:HostModel param.host 当前产品HostModel,可获取产品相关参数ClientModel param.client 当前产品所属用户ClientModel,可获取产品所属用户相关参数ProductModel param.product当前产品所属商品ProductModel,可获取产品对应商品相关参数ServerModel param.server 当前产品关联接口ServerModel,可获取关联接口相关参数array param.custom 升降级参数返回:无 12.购物车价格计算 cartCalculatePrice必须实现该方法,当商品计算价格或结算时会调用该方法例子:public function cartCalculatePrice($param){$res = [ 'status' => 200, 'msg' => '请求成功', 'data' => [ 'price' => 1.1, 'renew_price' => 1.1, 'billing_cycle' => '月', 'duration' => 30*24*3600, 'description' => 'CPU:2核,内存:4G通用型云主机', 'base_price' => 1.1 ]];return $res;} 参数:ProductModel param.product当前商品ProductModel,可获商品相关参数array param.custom 模块自定义参数int param.qty 商品数量string param.scene 场景(cal_price=计算价格,buy=结算) 返回: int status 状态(200=成功,400=失败)string msg 信息float data.price 价格float data.renew_price 续费价格string data.billing_cycle 周期名称int data.duration 周期时长(秒)string data.description 订单子项描述float data.base_price 基础价格 13.后台商品接口配置输出 serverConfigOption建议实现该方法位置: 后台-商品管理-商品内页-接口管理，关联接口或接口分组后下方输出例子:public function serverConfigOption($param){$res = ['template'=>'template/admin/mf_dcim.html','vars' => []];// $res = "我是输出";return $res;} 参数:ProductModel param.product当前商品ProductModel,可获取商品相关参数返回:string|array返回string时：要输出的内容返回array时：string template 模板地址,从模块根目录开始算array vars 替换模板变量,注意不要和系统变量冲突,使用thinkphp自带模板语法 14.前台导航产品列表 hostList必须实现该方法例子:public function hostList($param){$res = ['template'=>'template/clientarea/product_list.html','vars' => []];// $res = "我是输出";return $res;} 参数:array param.product_id 当前导航关联的所有商品ID 返回:string|array返回string时：要输出的内容返回array时：string template 模板地址,从模块根目录开始算array vars 替换模板变量,注意不要和系统变量冲突,使用thinkphp自带模板语法 15.前台产品内页输出 clientArea必须实现该方法例子:public function clientArea($param){$res = ['template'=>'template/clientarea/product_detail.html','vars' => []];// $res = "我是输出";return $res;} 参数:HostModel param.host 当前产品HostModel,可获取产品相关参数ClientModel param.client 当前产品所属用户ClientModel,可获取产品所属用户相关参数ProductModel param.product 当前产品所属商品ProductModel,可获取产品对应商品相关参数ServerModel param.server 当前产品关联接口ServerModel,可获取关联接口相关参数返回:string|array返回string时：要输出的内容返回array时：string template 模板地址,从模块根目录开始算array vars 替换模板变量,注意不要和系统变量冲突,使用thinkphp自带模板语法 16.后台产品内页输出 adminArea按需实现该方法位置: 后台-用户管理-用户列表-用户详情-产品信息最底部输出例子:public function adminArea($param){$res = ['template'=>'template/admin/product_detail.html','vars' => []];// $res = "我是输出";return $res;} 参数:HostModel param.host 当前产品HostModel,可获取产品相关参数ClientModel param.client 当前产品所属用户ClientModel,可获取产品所属用户相关参数ProductModel param.product 当前产品所属商品ProductModel,可获取产品对应商品相关参数ServerModel param.server 当前产品关联接口ServerModel,可获取关联接口相关参数返回:string|array返回string时：要输出的内容返回array时：string template 模板地址,从模块根目录开始算array vars 替换模板变量,注意不要和系统变量冲突,使用thinkphp自带模板语法 17.前台商品购买页面输出 clientProductConfigOption必须实现该方法,否则将不能购买该商品位置: 前台-订购产品-具体商品购买例子:public function clientProductConfigOption($param){$res = ['template'=>'template/clientarea/goods.html','vars' => []];// $res = "我是输出";return $res;} 参数:ProductModel param.product 当前商品ProductModel,可获取商品相关参数返回:string|array返回string时：要输出的内容返回array时：string template 模板地址,从模块根目录开始算array vars 替换模板变量,注意不要和系统变量冲突,使用thinkphp自带模板语法 18.结算之后调用 afterSettle建议实现该方法，一般用于存入关联关系例子:public function afterSettle($param){// 具体逻辑} 参数:ProductModel param.product 当前商品ProductModel,可获取商品相关参数int param.host_id 创建的产品IDarray param.custom 模块自定义参数array param.customfields 其他自定义参数返回:无 19.获取当前产品所有周期价格 durationPrice建议实现该方法, 一般用于给续费提供周期价格例子:public function durationPrice($param){$res = [ 'status' => 200, 'msg' => '请求成功', 'data' => [[ 'duration' => 30*24*3600, 'billing_cycle' => '月', 'price' => 1.1,] ] ];} 参数:HostModel param.host 当前产品HostModel,可获取产品相关参数ClientModel param.client 当前产品所属用户ClientModel,可获取产品所属用户相关参数ProductModel param.product 当前产品所属商品ProductModel,可获取产品对应商品相关参数ServerModel param.server 当前产品关联接口ServerModel,可获取关联接口相关参数返回:int status 状态(200=成功,400=失败)string msg 信息float data[].price 价格string data[].billing_cycle 周期名称int data[].duration 周期时长(秒) 20.获取商品起售周期价格 getPriceCycle建议实现该方法显示位置:后台-商品管理-商品管理-商品内页基础信息-商品起售价格前台-订购商品列表周期价格例子:public function getPriceCycle($param){$res = [ 'price' => 1.1, 'cycle' => '月', ];return $res;} 参数:ProductModel param.product 当前商品ProductModel,可获取商品相关参数返回float price 商品起售价格string cycle 周期 21.下载上游资源 downloadResource按需实现该方法如果需要实现上下游，需要使用该方法, 并且需要实现对应的reserver模块，同时把reserver模块打包在该模块中例子:public function downloadResource($param){$res = [ 'status' => 200, 'msg' => '获取成功', 'data' => ['module' => 'mf_dcim','url' => request()->domain() . '/plugins/server/mf_dcim/data/abc.zip', 'version'=> '1.0.1', ] ];return $res;} 参数:ProductModel param.product 当前商品ProductModel,可获取商品相关参数返回:int status 状态(200=成功,400=失败)string msg 信息string data.module 对应reserver模块名称string data.url 对应reserver模块zip包string version 当前模块版本号 22.产品内页模块配置信息输出 adminField按需实现该方法位置:用户管理-用户列表-用户内页-产品信息-产品内页配置信息例子:public function adminField($param){$res = [ ['name' => '基础配置', 'field' => [ [ 'name' => '数据中心', 'key' => 'data_center', 'value' => '中国-香港', 'disable' => true, ]] ] ];return $res;} 参数:HostModel param.host 当前产品HostModel,可获取产品相关参数ClientModel param.client 当前产品所属用户ClientModel,可获取产品所属用户相关参数ProductModel param.product 当前产品所属商品ProductModel,可获取产品对应商品相关参数ServerModel param.server 当前产品关联接口ServerModel,可获取关联接口相关参数返回:string [].name 配置小标题string [].field[].name 名称string [].field[].key 标识(不要重复)string [].field[].value 当前值bool [].field[].disable 状态(false=可修改,true=不可修改) 23.产品保存后 hostUpdate按需实现该方法,该方法建议和adminField方法一起使用例子:public function hostUpdate($param){// 实现配置变更逻辑} 参数:HostModel param.host 当前产品HostModel,可获取产品相关参数ClientModel param.client 当前产品所属用户ClientModel,可获取产品所属用户相关参数ProductModel param.product 当前产品所属商品ProductModel,可获取产品对应商品相关参数ServerModel param.server 当前产品关联接口ServerModel,可获取关联接口相关参数array param.module_admin_field 模块自定义配置信息(键是配置标识,值是填写的内容) 返回:int status 状态(200=成功,400=失败)string msg 提示信息 24.获取商品所有配置项 allConfigOption不推荐使用该方法,需要返回商品的所有配置例子:public function allConfigOption($param){$res = [ 'status' => 200, 'msg' => '获取成功', 'data' => [ [ 'name' => '内存', 'field' => 'memory', 'type' => 'dropdown', 'option'=> [ [ 'name' => '2G', 'value'=> '2', ] ] ] ]];return $res;} 参数:ProductModel param.product 当前商品ProductModel,可获取商品相关参数返回:int status 状态(200=成功,400=失败)string msg 信息string data[].name 配置项名称string data[].field 订购时对应配置的键string data[].type 类型(dropdown=下拉),只支持下拉string data[].option[].name 选项名称int|string data[].option[].value 对应选项值

业务系统开发文档>短信接口开发文档

quot;status"=>"success","template"=>["template_id"=>"w3423","template_status"=>2]]；失败示例：["status"=>"error","msg"=>"模板ID错误"]createCnTemplate创建国内模板title：模板标题；content：模板内容；config：自定义配置；示例：["title"=>"test","content"=>"测试内容","config"=>{"key"=>"value"}]status：状态，success成功，error失败；template.template_id：模板ID；template.template_status：模板状态，0未提交，1审核中，2通过，3未通过；成功示例：["status"=>"success","template"=>["template_id"=>"w3423","template_status"=>2]]；失败示例：["status"=>"error","msg"=>"模板ID错误"] putCnTemplate修改国内模板title：模板标题；content：模板内容；config：自定义配置；示例：["title"=>"test","content"=>"测试内容","config"=>{"key"=>"value"}]status：状态，success成功，error失败；template.template_id：模板ID；template.template_status：模板状态，0未提交，1审核中，2通过，3未通过；成功示例：["status"=>"success","template"=>["template_id"=>"w3423","template_status"=>2]]；失败示例：["status"=>"error","msg"=>"模板ID错误"] deleteCnTemplate删除国内模板template_id：模板ID；config：自定义配置；示例：['template_id'=>1,'config'=>{}]；status：状态，success成功，error失败；成功示例：["status"=>"success"]；失败示例：["status"=>"error","msg"=>"模板ID错误"] sendCnSms发送国内短信mobile：手机号；content：模板内容；config：自定义配置；template_id：模板ID；templateParam：模板参数，参考附表1示例：["mobile"=>"129483782423","content"=>"测试内容","config"=>{"key"=>"value"},'template_id'=>1,'templateParam'=>1]status：状态，success成功，error失败；content：已替换参数的模板内容；msg：错误信息成功示例：["status"=>"success","content"=>"测试内容"]；失败示例：["status"=>"error","msg"=>"模板ID错误","content"=>"测试内容"] getGlobalTemplate获取国际模板template_id：模板ID；config：自定义配置；示例：['template_id'=>1,'config'=>{}]；status：状态，success成功，error失败；template.template_id：模板ID；template.template_status：模板状态，0未提交，1审核中，2通过，3未通过；成功示例：["status"=>"success","template"=>["template_id"=>"w3423","template_status"=>2]]；失败示例：["status"=>"error","msg"=>"模板ID错误"]createGlobalTemplate创建国际模板title：模板标题；content：模板内容；config：自定义配置；示例：["title"=>"test","content"=>"测试内容","config"=>{"key"=>"value"}]status：状态，success成功，error失败；template.template_id：模板ID；template.template_status：模板状态，0未提交，1审核中，2通过，3未通过；成功示例：["status"=>"success","template"=>["template_id"=>"w3423","template_status"=>2]]；失败示例：["status"=>"error","msg"=>"模板ID错误"] putGlobalTemplate修改国际模板title：模板标题；content：模板内容；config：自定义配置；示例：["title"=>"test","content"=>"测试内容","config"=>{"key"=>"value"}]status：状态，success成功，error失败；template.template_id：模板ID；template.template_status：模板状态，0未提交，1审核中，2通过，3未通过；成功示例：["status"=>"success","template"=>["template_id"=>"w3423","template_status"=>2]]；失败示例：["status"=>"error","msg"=>"模板ID错误"] deleteGlobalTemplate删除国际模板template_id：模板ID；config：自定义配置；示例：['template_id'=>1,'config'=>{}]；status：状态，success成功，error失败；成功示例：["status"=>"success"]；失败示例：["status"=>"error","msg"=>"模板ID错误"] sendGlobalSms发送国际短信mobile：手机号；content：模板内容；config：自定义配置；template_id：模板ID；templateParam：模板参数，参考附表1示例：["mobile"=>"129483782423","content"=>"测试内容","config"=>{"key"=>"value"},'template_id'=>1,'templateParam'=>1]status：状态，success成功，error失败；content：已替换参数的模板内容；msg：错误信息成功示例：["status"=>"success","content"=>"测试内容"]；失败示例：["status"=>"error","msg"=>"模板ID错误","content"=>"测试内容"] 3、创建默认短信模板①在插件根目录下创建config/smsTemplate.php文件；②文件内容返回一个数组即可，如下：return [ [ 'title' => '验证码', 'content' => '验证码@var(code),5分钟内有效！请勿泄漏于他人', 'name'=>'code' ],]title标题；content内容，带参数；name为系统模板标识，唯一；③系统默认模板参考附表2；④在install安装中返回模板数组，系统会自动创建模板； 4、到后台短信通知管理，可以查看接口列表，安装、配置即可使用。四、示例参考智简魔方官方短信平台接口idcsmart 五、附附表1、templateParam参数列表（国际国内参数一样）参数名描述类型示例system_website_name系统网站名系统智简魔方system_website_url系统网站地址系统www.idcsmart.comorder_id订单ID订单125order_create_time订单创建时间订单1707094285order_amount订单金额订单1.00product_name产品名称（包括商品名和主机名）产品测试-ser23142123product_marker_name商品名称产品测试product_first_payment_amount产品首付金额产品100.00product_renew_amount产品续费金额产品100.00product_binlly_cycle产品周期产品计费周期免费free，一次onetime，周期先付recurring_prepayment,周期后付recurring_postpaidproduct_active_time产品激活时间产品1707094285product_due_time产品到期时间产品1707094285product_suspend_reason产品暂停原因产品到期暂停renewal_first续费X天后到期第一次提醒产品1renewal_second续费X天后到期第二次提醒产品2client_register_time客户注册时间客户1707094285client_username用户名客户testclient_email邮件客户135460@qq.comclient_phone手机号客户16548765643client_company公司客户智简魔方client_last_login_time最后登录时间客户1707094285client_last_login_ip最后登录ip客户122.32.13.3account账户名客户test 附表2、系统默认短信模板（以下模板内容为官方短信平台模板内容，使用需修改）系统模板标识（name）模板标题（title）模板类型模板内容（content）示例code验证码系统验证码@var(code),5分钟内有效！请勿泄漏于他人client_login_success用户登录客户您的账号@var(account)成功登录系统，如不是本人操作请及时修改密码client_register_success用户注册客户@var(account)，感谢您支持@var(system_website_name)client_change_phone客户更改手机客户您的手机号被改为：@var(client_phone)，请注意账户安全client_change_password客户更改密码客户您的密码被改为：@var(client_password)，请注意账户安全order_create订单创建订单您已下单，订单：@var(order_id)（订单号），请及时支付host_pending产品开通中产品您的产品：@var(product_name)（产品名称）正在开通，请耐心等待host_active开通成功产品您的产品：@var(product_name)（产品名称），已开通可使用host_suspend产品暂停通知产品您的产品：@var(product_name)（产品名称），由于@var(product_suspend_reason)，已停用host_unsuspend产品解除暂停通知产品您的产品：@var(product_name)（产品名称），已解除暂停host_terminate产品删除通知产品您的产品：@var(product_name)（产品名称），由于到期未续费，已删除host_upgrad产品升降级产品您已成功升级产品@var(product_name)，感谢您的支持host_renewal_first第一次续费提醒产品您的产品：@var(product_name)（产品名称），还有@var(renewal_first)天到期，请及时续费host_renewal_second第二次续费提醒产品您的产品：@var(product_name)（产品名称），还有@var(renewal_second)天到期，请及时续费host_overdue_first逾期付款第一次提醒产品您的产品：@var(product_name)（产品名称）已到期，将会删除，请及时续费host_overdue_second逾期付款第二次提醒产品您的产品：@var(product_name)（产品名称）已到期，将会删除，请及时续费host_overdue_third逾期付款第三次提醒产品您的产品：@var(product_name)（产品名称）已到期，将会删除，请及时续费order_overdue订单未付款通知订单您的订单：@var(order_id)（订单号）尚未支付，金额@var(order_amount)，请及时支付admin_order_amount订单金额修改订单您的订单：@var(order_id)（订单号）金额修改为@var(order_amount)，请及时支付order_pay订单支付通知订单您的订单：@var(order_id)（订单号）支付成功，支付金额为：@var(order_amount)元order_recharge充值成功通知订单充值成功，本次充值金额为：@var(order_amount)元