API接口文档

公共数据

创建于 2021-11-22 / 最近更新于 2021-11-22 / 3518
字体: [默认] [大] [更大]

简要描述

公共数据

接口版本

版本号 制定人 制定日期 修订日期
1.0.0 Devil 2020-09-29

请求URL

base/common

请求方式

POST

公共参数

参数名 是否必须 类型 默认值 描述
application string web 请求应用、参考公共中详解
application_client_type string pc 请求客户端、参考公共中详解
token string token

请求参数

{
    "is_key": "0"
}
参数名 是否必须 类型 默认值 描述
is_key int 配置索引使用插件标识符(0否、1是)

返回示例

正确时返回

{
    "msg": "success",
    "code": 0,
    "data": {
        "status": 1,
        "config": {
            "common_site_type": 4,
            "common_shop_notice": "公告内容",
            "agreement_userregister_url": "https://d1.shopxo.vip/agreement/index/document/userregister/is_content/1.html",
            "agreement_userprivacy_url": "https://d1.shopxo.vip/agreement/index/document/userprivacy/is_content/1.html",
            "common_app_is_enable_search": 0,
            "common_app_is_enable_answer": 0,
            "common_app_is_header_nav_fixed": 0,
            "common_app_is_online_service": 1,
            "common_app_customer_service_tel": "021-88888888",
            "common_is_login_answer": 0,
            "common_order_close_limit_time": 30,
            "common_order_success_limit_time": 21600,
            "common_pay_log_order_close_limit_time": 30,
            "common_cdn_attachment_host": null,
            "common_cdn_public_host": null,
            "common_verify_expire_time": 600,
            "common_verify_interval_time": 60,
            "common_img_verify_state": 1,
            "home_site_user_forgetpwd_ad_images": [
                {
                    "images": "https://d1.shopxo.vip/static/upload/images/common/2019/05/17/1558072588843696.jpg",
                    "url": "https://shopxo.net/",
                    "bg_color": "#FAFAFA"
                },
                {
                    "images": "https://d1.shopxo.vip/static/upload/images/common/2019/05/17/1558073623641199.jpg",
                    "url": null,
                    "bg_color": "#FAFAFA"
                }
            ],
            "home_user_login_type": [
                "username",
                "email",
                "sms"
            ],
            "home_user_login_img_verify_state": 1,
            "home_site_user_login_ad_images": [
                {
                    "images": "https://d1.shopxo.vip/static/upload/images/common/2019/05/17/1558062481107570.jpg",
                    "url": "https://shopxo.net/",
                    "bg_color": null
                },
                {
                    "images": "https://d1.shopxo.vip/static/upload/images/common/2019/05/17/1558072588843696.jpg",
                    "url": "https://ask.shopxo.net/",
                    "bg_color": "#FAFAFA"
                },
                {
                    "images": "https://d1.shopxo.vip/static/upload/images/common/2019/05/17/1558073623385520.jpg",
                    "url": "https://shopxo.net/vip.html",
                    "bg_color": "#FAFAFA"
                }
            ],
            "home_user_reg_type": [
                "sms",
                "email",
                "username"
            ],
            "home_user_register_img_verify_state": 0,
            "common_register_is_enable_audit": 0,
            "home_is_enable_userregister_agreement": 1,
            "home_site_user_register_bg_images": "https://d1.shopxo.vip/static/upload/images/common/2019/05/17/1558025141249118.png",
            "common_user_is_onekey_bind_mobile": 0,
            "common_user_is_mandatory_bind_mobile": 0,
            "home_site_name": "ShopXO",
            "home_site_logo": "https://d1.shopxo.vip/static/upload/images/common/2019/01/14/1547448705165706.png",
            "home_site_logo_wap": "https://d1.shopxo.vip/static/upload/images/common/2019/01/14/1547448748316693.png",
            "home_site_logo_square": "https://d1.shopxo.vip/static/upload/images/common/2019/01/14/1547448728921121.jpg",
            "home_site_state": 1,
            "home_site_close_reason": "升级中...",
            "home_site_icp": "沪ICP备xxx号",
            "home_site_security_record_name": "京公网安备xxx号",
            "home_site_security_record_url": null,
            "home_static_cache_version": "20200202",
            "home_footer_info": "<div style=\"background: rgb(255 224 224 / 60%);color: #f00;padding: 2px 5px;text-align:left;font-size: 12px;position: fixed;bottom: 0px;left: 0px;width: 195px;z-index: 100;border-top-right-radius: 3px;border: 1px solid #fc9797;\">\n演示站点请勿支付,可在后台站点配置->基础配置(底部代码)修改</div>",
            "home_index_floor_data_type": 0,
            "home_index_banner_left_status": 1,
            "home_index_banner_right_status": 1,
            "home_search_limit_number": 20,
            "home_search_is_brand": 1,
            "home_search_is_category": 1,
            "home_search_is_price": 1,
            "home_search_is_params": 1,
            "home_search_is_spec": 1,
            "home_index_friendship_link_status": 0,
            "home_header_top_is_home": 1,
            "home_navigation_main_quick_status": 1,
            "home_navigation_main_quick_name": "百宝箱",
            "home_user_address_map_status": 0,
            "home_user_address_idcard_status": 0,
            "home_extraction_address_position": 0,
            "home_is_enable_order_bulk_pay": 0,
            "common_order_is_booking": 0,
            "common_user_center_notice": "用户中心公告文字,后台配置修改,演示站点请勿下单。",
            "common_app_is_head_vice_nav": 0,
            "category_show_level": "3",
            "common_app_is_use_mobile_detail": 0,
            "common_app_is_good_thing": 0,
            "common_app_is_poster_share": 0,
            "common_is_show_goods_comments": 1,
            "common_is_goods_detail_show_photo": 0,
            "common_is_exhibition_mode_btn_text": "立即咨询",
            "common_baidu_map_ak": "XSdiGjfg3wOHiKjpYEMG6CYA",
            "common_customer_store_tel": "021-88888888",
            "common_customer_store_email": "test@qq.com",
            "common_customer_store_address": "上海市 浦东新区",
            "common_customer_store_qrcode": "https://d1.shopxo.vip/static/upload/images/common/2019/04/09/1554805439263794.jpeg",
            "home_seo_site_title": "ShopXO企业级B2C电商系统提供商 - 演示站点",
            "home_seo_site_keywords": "商城系统,开源电商系统,免费电商系统,PHP电商系统,商城系统,B2C电商系统,B2B2C电商系统",
            "home_seo_site_description": "ShopXO是国内领先的商城系统提供商,为企业提供php商城系统、微信商城、小程序。"
        },
        "currency_symbol": "¥",
        "quick_nav": [
            {
                "id": "1",
                "name": "分类",
                "images_url": "https://d1.shopxo.vip/static/upload/images/quick_nav/2020/09/11/1599806728463641.png",
                "event_value": "index.php?s=/index/category/index.html",
                "event_type": "0",
                "bg_color": "#FF9933",
                "images_url_old": "/static/upload/images/quick_nav/2020/09/11/1599806728463641.png"
            }
        ],
        "plugins_base": {
            "blog": {
                "id": "14",
                "plugins": "blog",
                "data": {
                    "application_name": "博客",
                    "home_data_list_number": "",
                    "home_multigraph_number": "",
                    "home_bottom_goods_page_size": "",
                    "search_page_size": "",
                    "search_right_goods_number": "",
                    "right_recommended_number": "",
                    "seo_title": "",
                    "seo_keywords": "",
                    "seo_desc": "",
                    "home_bottom_goods_order_by_type": "0",
                    "home_bottom_goods_order_by_rule": "0",
                    "is_home_hot_auto_play": "1"
                }
            }
        }
    }
}

错误时返回

{
    "msg": "error",
    "code": -1,
    "data": []
}

返回参数说明 -> data

参数名 是否必须 类型 描述
status int 全局状态值(1接口执行成功,用于前端校验接口请求完成状态,以后再加入其它状态)
config array 基础配置信息
currency_symbol string 价格符号
quick_nav array 快捷导航
plugins_base array 所有可用的插件配置

备注

更多返回错误代码请看首页的错误代码描述

3 人点赞过