主题
公共接口(前台,无需登录)
获取国家列表
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取国家列表,包括国家名,中文名,区号 |
| 接口地址 | /console/v1/country |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| keywords | string | - | 搜索范围国家名中文名区号validate:optional | desc:关键字 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list | array | - | desc:国家列表 |
| list[].name | string | - | desc:国家名 |
| list[].name_zh | string | - | desc:中文名 |
| list[].phone_code | int | - | desc:区号 |
| list[].iso | string | - | desc:国家英文缩写 |
| count | int | - | desc:国家总数 |
发送手机验证码
| 项目 | 内容 |
|---|---|
| 接口描述 | 发送手机验证码 |
| 接口地址 | /console/v1/phone/code |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| action | string | - | login登录register注册verify验证手机update修改手机password_reset重置密码exception_login异常登录update_password修改密码update_operate_password修改操作密码host_transfer产品转移validate:required | desc:验证动作 |
| phone_code | int | - | 未登录或修改手机时需要validate:optional | desc:国际电话区号 |
| phone | string | - | 未登录或修改手机时需要validate:optional | desc:手机号 |
| token | string | - | validate:optional | desc:图形验证码唯一识别码 |
| captcha | string | - | validate:optional | desc:图形验证码 |
响应参数
无
发送邮件验证码
| 项目 | 内容 |
|---|---|
| 接口描述 | 发送邮件验证码 |
| 接口地址 | /console/v1/email/code |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| action | string | - | login登录register注册verify验证邮箱update修改邮箱password_reset重置密码exception_login异常登录update_password修改密码update_operate_password修改操作密码host_transfer产品转移validate:required | desc:验证动作 |
| string | - | 未登录或修改邮箱时需要validate:optional | desc:邮箱 | |
| token | string | - | validate:optional | desc:图形验证码唯一识别码 |
| captcha | string | - | validate:optional | desc:图形验证码 |
响应参数
无
图形验证码
| 项目 | 内容 |
|---|---|
| 接口描述 | 图形验证码 |
| 接口地址 | /console/v1/captcha |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
无
响应参数
| name | type | default | desc |
|---|---|---|---|
| html | string | - | desc:html文档 |
支付接口
| 项目 | 内容 |
|---|---|
| 接口描述 | 支付接口 |
| 接口地址 | /console/v1/gateway |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
无
响应参数
| name | type | default | desc |
|---|---|---|---|
| list | array | - | desc:支付接口列表 |
| list[].id | int | - | desc:ID |
| list[].title | string | - | desc:名称 |
| list[].name | string | - | desc:标识 |
| list[].url | string | - | desc:图片 |
| count | int | - | desc:总数 |
公共配置
| 项目 | 内容 |
|---|---|
| 接口描述 | 公共配置 |
| 接口地址 | /console/v1/common |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| account | string | - | validate:optional | desc:账户 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| lang_list | array | - | desc:语言列表 |
| lang_home | string | - | desc:前台默认语言 |
| lang_home_open | int | - | desc:前台多语言开关 |
| maintenance_mode | int | - | desc:维护模式开关 |
| maintenance_mode_message | string | - | desc:维护模式内容 |
| website_name | string | - | desc:网站名称 |
| website_url | string | - | desc:网站域名地址 |
| terms_service_url | string | - | desc:服务条款地址 |
| terms_privacy_url | string | - | desc:隐私条款地址 |
| prohibit_user_information_changes | array | - | desc:禁止用户信息变更 |
| login_phone_verify | int | - | desc:手机号登录短信验证开关 |
| captcha_client_register | int | - | desc:客户注册图形验证码开关 |
| captcha_client_login | int | - | desc:客户登录图形验证码开关 |
| captcha_client_login_error | int | - | desc:客户登录失败图形验证码开关 |
| captcha_client_login_error_3_times | int | - | desc:客户登录失败3次 |
| captcha_client_verify | int | - | desc:验证手机邮箱图形验证码开关 |
| captcha_client_update | int | - | desc:修改手机邮箱图形验证码开关 |
| captcha_client_password_reset | int | - | desc:重置密码图形验证码开关 |
| captcha_client_oauth | int | - | desc:三方登录图形验证码开关 |
| captcha_client_security_verify | int | - | desc:安全校验是否开启图形验证码 |
| register_email | int | - | desc:邮箱注册开关 |
| register_phone | int | - | desc:手机号注册开关 |
| recharge_open | int | - | desc:启用充值 |
| recharge_min | float | - | desc:单笔最小金额 |
| recharge_max | float | - | desc:单笔最大金额 |
| currency_code | string | - | desc:货币代码 |
| currency_prefix | string | - | desc:货币符号 |
| currency_suffix | string | - | desc:货币后缀 |
| code_client_email_register | int | - | desc:邮箱注册数字验证码开关 |
| system_logo | string | - | desc:系统LOGO |
| put_on_record | string | - | desc:备案信息 |
| enterprise_name | string | - | desc:企业名称 |
| enterprise_telephone | string | - | desc:企业电话 |
| enterprise_mailbox | string | - | desc:企业邮箱 |
| enterprise_qrcode | string | - | desc:企业二维码 |
| online_customer_service_link | string | - | desc:在线客服链接 |
| icp_info | string | - | desc:ICP信息 |
| icp_info_link | string | - | desc:ICP信息链接 |
| public_security_network_preparation | string | - | desc:公安网备 |
| public_security_network_preparation_link | string | - | desc:公安网备链接 |
| telecom_appreciation | string | - | desc:电信增值 |
| copyright_info | string | - | desc:版权信息 |
| official_website_logo | string | - | desc:官网LOGO |
| cloud_product_link | string | - | desc:云产品跳转链接 |
| dcim_product_link | string | - | desc:DCIM产品跳转链接 |
| clientarea_logo_url | string | - | desc:会员中心LOGO跳转地址 |
| clientarea_logo_url_blank | int | - | desc:会员中心LOGO跳转是否打开新页面 |
| feedback_type | array | - | desc:意见反馈类型 |
| feedback_type[].id | int | - | desc:意见反馈类型ID |
| feedback_type[].name | string | - | desc:名称 |
| feedback_type[].description | string | - | desc:描述 |
| friendly_link | array | - | desc:友情链接 |
| friendly_link[].id | int | - | desc:友情链接ID |
| friendly_link[].name | string | - | desc:名称 |
| friendly_link[].url | string | - | desc:链接地址 |
| honor | array | - | desc:荣誉资质 |
| honor[].id | int | - | desc:荣誉资质ID |
| honor[].name | string | - | desc:名称 |
| honor[].img | string | - | desc:图片地址 |
| partner | array | - | desc:合作伙伴 |
| partner[].id | int | - | desc:合作伙伴ID |
| partner[].name | string | - | desc:名称 |
| partner[].img | string | - | desc:图片地址 |
| partner[].description | string | - | desc:描述 |
| cron_due_renewal_first_swhitch | int | - | desc:是否开启自动续费功能 |
| cron_due_renewal_first_day | int | - | desc:提前多少天续费 |
| oauth | array | - | desc:三方登录列表 |
| oauth[].img | string | - | desc:图标地址 |
| oauth[].name | string | - | desc:三方登录标识 |
| oauth[].title | string | - | desc:三方登录名称 |
| oauth[].url | string | - | desc:请求地址 |
| home_enforce_safe_method | array | - | desc:前台强制安全选项 |
| recharge_money_notice_content | string | - | desc:充值金额提示内容 |
| recharge_pay_notice_content | string | - | desc:充值支付提示内容 |
| first_login_method | string | - | desc:账户凭证首选登录方式 |
| first_password_login_method | string | - | desc:密码登录首选 |
| cart_instruction | int | - | desc:购物车说明开关 |
| cart_instruction_content | string | - | desc:购物车说明内容 |
| cart_change_product | int | - | desc:购物车切换商品开关 |
| plugin_configuration | object | - | desc:插件配置 |
| plugin_configuration.idcsmart_sale.register_hide_sale | int | - | desc:用户注册时隐藏我有销售 |
| login_email_password | int | - | desc:是否开启邮箱密码登录 |
| login_phone_password | int | - | desc:是否开启手机密码登录 |
| first_login_type | string | - | desc:首选登录方式 |
| clientarea_theme_display_one | string | - | desc:主题区域展示内容1 |
| clientarea_theme_display | string | - | desc:主题区域展示内容2 |
| clientarea_theme_banner_list | array | - | desc:banner列表 |
| donot_save_client_product_password | int | - | desc:不保存用户产品密码 |
| edition | int | - | desc:版本 |
文件上传
| 项目 | 内容 |
|---|---|
| 接口描述 | 文件上传 |
| 接口地址 | /console/v1/upload |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| file | resource | - | validate:required | desc:文件资源 |
| move | int | - | 0否1是仅支持图片validate:optional | desc:移动资源 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| save_name | string | - | desc:文件名 |
| data.image_base64 | string | - | desc:图片base64 |
| data.image_url | string | - | desc:图片地址 |
全局搜索
| 项目 | 内容 |
|---|---|
| 接口描述 | 全局搜索 |
| 接口地址 | /console/v1/global_search |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| keywords | string | - | 搜索范围用户姓名公司邮箱手机号商品名称商品一级分组名称商品二级分组名称产品ID标识商品名称validate:required | desc:关键字 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| hosts | array | - | desc:产品列表 |
| hosts[].id | int | - | desc:产品ID |
| hosts[].name | string | - | desc:标识 |
| hosts[].product_name | string | - | desc:商品名称 |
获取前台导航
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取前台导航 |
| 接口地址 | /console/v1/menu |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
无
响应参数
| name | type | default | desc |
|---|---|---|---|
| menu | array | - | desc:菜单列表 |
| menu[].id | int | - | desc:菜单ID |
| menu[].name | string | - | desc:名称 |
| menu[].url | string | - | desc:网址 |
| menu[].menu_type | string | - | desc:菜单类型 |
| menu[].second_reminder | int | - | desc:二次提醒 |
| menu[].icon | string | - | desc:图标 |
| menu[].parent_id | int | - | desc:父ID |
| menu[].is_cross_module | int | - | desc:是否为跨模块列表 |
| menu[].select_field | array | - | desc:选择字段 |
| menu[].child | array | - | desc:子菜单 |
| menu[].child[].id | int | - | desc:菜单ID |
| menu[].child[].name | string | - | desc:名称 |
| menu[].child[].url | string | - | desc:网址 |
| menu[].child[].second_reminder | int | - | desc:二次提醒 |
| menu[].child[].icon | string | - | desc:图标 |
| menu[].child[].parent_id | int | - | desc:父ID |
| menu[].child[].is_cross_module | int | - | desc:是否为跨模块列表 |
| menu[].child[].select_field | array | - | desc:选择字段 |
权限列表
| 项目 | 内容 |
|---|---|
| 接口描述 | 权限列表 |
| 接口地址 | /console/v1/auth |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
无
响应参数
| name | type | default | desc |
|---|---|---|---|
| list | array | - | desc:权限列表 |
| list[].id | int | - | desc:权限ID |
| list[].title | string | - | desc:权限标题 |
| list[].url | string | - | desc:地址 |
| list[].order | int | - | desc:排序 |
| list[].parent_id | int | - | desc:父级ID |
| list[].module | string | - | desc:插件模块路径 |
| list[].plugin | string | - | desc:插件标识名 |
| list[].rules | array | - | desc:权限规则标题 |
| list[].child | array | - | desc:权限子集 |
| list[].child[].id | int | - | desc:权限ID |
| list[].child[].title | string | - | desc:权限标题 |
| list[].child[].url | string | - | desc:地址 |
| list[].child[].order | int | - | desc:排序 |
| list[].child[].parent_id | int | - | desc:父级ID |
| list[].child[].module | string | - | desc:插件模块路径 |
| list[].child[].plugin | string | - | desc:插件标识名 |
| list[].child[].rules | string | - | desc:权限规则标题 |
| list[].child[].child | array | - | desc:权限子集 |
| list[].child[].child[].id | int | - | desc:权限ID |
| list[].child[].child[].title | string | - | desc:权限标题 |
| list[].child[].child[].url | string | - | desc:地址 |
| list[].child[].child[].order | int | - | desc:排序 |
| list[].child[].child[].parent_id | int | - | desc:父级ID |
| list[].child[].child[].module | string | - | desc:插件模块路径 |
| list[].child[].child[].plugin | string | - | desc:插件标识名 |
| list[].child[].child[].rules | string | - | desc:权限规则标题 |
| widget[].id | string | - | desc:挂件标识 |
| widget[].title | string | - | desc:挂件标题 |
提交意见反馈
| 项目 | 内容 |
|---|---|
| 接口描述 | 提交意见反馈 |
| 接口地址 | /console/v1/feedback |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| type | int | - | validate:required | desc:类型 |
| title | string | - | validate:required | desc:标题 |
| description | string | - | validate:required | desc:描述 |
| attachment | array | - | validate:optional | desc:附件 |
| contact | string | - | validate:optional | desc:联系方式 |
响应参数
无
提交方案咨询
| 项目 | 内容 |
|---|---|
| 接口描述 | 提交方案咨询 |
| 接口地址 | /console/v1/consult |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| contact | string | - | validate:required | desc:联系人 |
| company | string | - | validate:optional | desc:公司名称 |
| phone | string | - | 手机号码和邮箱二选一必填validate:optional | desc:手机号码 |
| string | - | 手机号码和邮箱二选一必填validate:optional | desc:联系邮箱 | |
| matter | string | - | validate:required | desc:咨询产品 |
响应参数
无
获取文件资源(支持预览或者下载)
| 项目 | 内容 |
|---|---|
| 接口描述 | 获取文件资源(支持预览或者下载) |
| 接口地址 | /console/v1/resource |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| fid | string | - | validate:required | desc:文件唯一ID |
| rand_str | string | - | validate:required | desc:随机字符串 |
| sign | string | - | validate:required | desc:签名 |
| expires | int | - | validate:required | desc:过期时间 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| - | string | desc:文件内容 | - |
修改语言
| 项目 | 内容 |
|---|---|
| 接口描述 | 修改语言 |
| 接口地址 | /console/v1/language |
| 请求方式 | PUT |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| language | string | - | validate:required | desc:语言 |
响应参数
无