WeMake · 开放平台

功能入口

位置：运营端 - 总览

地址：sp.{工业环境域名}/overview

功能说明

总览模块用于显示不同模块下一些运营端数据的汇总信息，比如：服务销售情况（总收入、订单总数等）、客户统计数据（注册数、企业数、子用户数等）。

第三方接入时有的产品需要在运营端总览页展示各自模块的运营数据信息，本文档主要说明服务商如何接入。

准备工作

需服务商提供接入接口。工业云将服务商需要展示模块注册进来，数据展示部分通过注册进来的URL后端调用，包装后返给前端。提供接口URL需具备以下条件：注册的接口支持在请求头Cookie中传入sp_access_token。

（1）服务商需要接入工业云平台账号系统。

（2）实现数据统计接口，按照接口规范返回接口数据。

接口开发

接口要求

实现接口前注意以下要求：

项目	说明
传输协议	HTTP 传输协议
接口请求⽅式	GET/POST⽅法提交
请求头支持传sp_access_token	工业云侧请求接口时会在cookie上携带sp_access_token，服务商获取到sp_access_token后，解析出账号信息，从而查询出需要展示的统计数据返回。
传参及结果返回标准	需按照接口规范进行参数传值及返回。具体见下文8.2部分。

GET

如果是GET请求，无需传参。接口标准参考地市云控制台总览部分。支持如下图表展示数据：

POST

如果是POST请求，支持如下图表展示数据：

数据统计接口

接口URL

Method: POST/GET
Cookie: sp_access_token=UN2-WJEJNZOJHAJ7GRNUAW
Url: http://{third.domain.com}/{path}/sp/overall

请求参数说明

如果是GET请求，无需传参。

如果是POST请求，接口body需支持传入以下参数：

参数名	类型	说明
Unit	string	1代表天，2代表月
Begin	string	起始时间（单位 s）
End	string	结束时间（单位 s）
Type	string	对应工业云侧配置中的sub_cards.params.value

注意：服务商需提供给工业云侧获取统计数据的接口（下方sub_cards.http_url）及不同统计维度的值（下方sub_cards.params.value的值对应页面的不同维度统计项），然后按照接口返回标准实现接口即可。

sp_overall:
         - card_id: "1"
           card_name: "销售情况统计"
           redirect_url: ""
           ui_type: "1"
           sub_cards:
             - card_id: "1"
               card_name: "应用服务"
               redirect_url: ""
               is_open: true
               http_url: "http://web-cgi-node:3000/cgi/capi?cmd=DescribeAppSaleStatistics&OrderSource"
               http_type: "POST"
               params:
                 - name: "总收入"
                   value: "1"
                   chart_type: "BasicArea-stack"
                   unit: "元"
                 - name: "订单数"
                   value: "2"
                   chart_type: "StackBar"
                   unit: "个"

各字段含义：

字段	含义
card_id	卡片ID
card_name	卡片名称
ui_type	卡片类型目前有3种，基本折线图（BasicLine）堆叠柱状图（StackBar）堆叠面积图（BasicArea-stack）
sub_cards	子卡片
sub_cards.card_id	子卡片ID
sub_cards.card_name	子卡片名称
sub_cards.is_open	是否展示
sub_cards.http_url	请求URL
sub_cards.http_type	请求类型（GET/POST）
sub_cards.params.name	数据维度名称
sub_cards.params.value	数据维度值

响应参数说明

字段名	字段类型	字段描述
Code	Integer	返回码 0成功其他失败
Msg	string	错误信息
DataDisplays.Values.Name	string	统计信息名称
DataDisplays.Values.Value	string	统计信息数目
DataDisplays.Values.Url	string	统计信息跳转URL
DataDisplays.Values.Info	string	统计信息数目说明
DataDisplays.Values.Unit	string	统计信息数目单位
Detail.Name	string	详情标题
Detail.Values.Key	string	详情名称
Detail.Values.Value	string	详情值
Detail.Name	string	列表标题
SpData.Name	string	图标名称
SpData.Data.Time	string	图标时间（横轴）
SpData.Data.Value	double	图标统计数据（纵轴）

{
    "Code": 0,
    "Msg": "成功",
    "DataDisplays": [
        {
            "Values": [
                {
                    "Name": "总收入",
                    "Value": "0.99",
                    "Info": "",
                    "Url": "",
                    "Unit": "元"
                },
                {
                    "Name": "订单总数",
                    "Value": "99",
                    "Info": "",
                    "Url": "",
                    "Unit": ""
                }
            ]
        }
    ],
    "Detail": {
        "Name": "订单详情",
        "Values": [
            {
                "Key": "已交付",
                "Value": "99"
            },
            {
                "Key": "待支付",
                "Value": "99"
            },
            {
                "Key": "待交付",
                "Value": "99"
            },
            {
                "Key": "已关闭",
                "Value": "99"
            }
        ]
    },
    "SpData": [
        {
            "Name": "甄选应用",
            "Data": [
                {
                    "Time": "1595865600",
                    "Value": 0
                },
                {
                    "Time": "1595952000",
                    "Value": 0
                }
            ]
        },
        {
            "Name": "本地应用",
            "Data": [
                {
                    "Time": "1595865600",
                    "Value": 0
                },
                {
                    "Time": "1595952000",
                    "Value": 0
                }
            ]
        }
    ]
}

平台概述

应用接入在线调试指引

接入流程

接入准备

快速接入指引

OAuth接入

OAuth2.0接入

前端接入

底座接入

常见问题

本页目录：