平台基本功能

首页api监控

Api监控界面是对前台一些基本数据的统计和监控,用以掌握平台api调用情况,展示内容包含:60秒调用记录、api单日调用统计、单日异步消息数量、api申请待审批、开发者申请待审批,如下图所示:

下面对监控面板的内容做分别介绍:

  • 60秒调用记录:最近60秒内,prism前台总的api调用情况记录,分别显示请求数量、错误数量、成功率和平均耗时,如下图所示:

  • api单日调用统计:前台最近一个月内,以日为单位的api调用次数折线图,如下图所示:

  • 单日异步消息数量:最近一个月内,以日为单位记录异步通信次数折线图,如下图所示:

  • api申请待审批:api开发者申请上线或下线api服务的请求记录,在此可以执行审核操作,如下图所示:

  • 开发者申请待审批:普通开发者和api提供者两种身份的注册申请待审核记录,在此可以执行审核操作,如下图所示:

API

Api:分为三种状态:已上线、申请上线、申请下线

已上线:

已上线并正常提供服务的API列表,仅显示api服务名称,不显示各方法名称,如下图所示:

  • 操作:可执行下线操作,下线后前台开发者则不可使用该服务。

  • API:API群组的名称,点击可查看对其有权限的团队成员,可以做添加、删除操作,并可查看由开发者提供的该API参数节点配置信息。

  • 路径:API的前缀标识,用以表示api方法所属的服务,由创建者提供。

  • 方法数:该API服务包含多少个方法。

  • 今日调用:该API服务包含的各项方法,在今日被调用的总次数。

申请上线:

显示申请上线的api列表,管理员可以同意或拒绝上线申请,其他字段和功能同“已上线”,如下图所示:

申请下线:

显示申请下线的api列表,管理员可以同意或拒绝下线申请,其他字段同“已上线”,如下图所示:

应用

应用列表:开放平台开发者创建的所有应用,包含应用名称(管理)、说明、key使用数量记录,如下图所示:

应用名称(管理)

包含了该应用的一些基本信息,在此将分别说明,如下图所示:

  • key数量:该应用可创建的key总数和当前已创建的key数量;在此可以修改key的总数限制,也可以直接删除应用。

  • API调用权限:控制该应用可执行的api服务及方法,并限定可执行的最高频率。

  • 团队:设置对该应用有相应权限的其他用户。

  • 消息队列权限:查看该应用有哪些接收和发送消息队列的权限。

  • 其他:备注和metadata分别是用户通过应用在meta中填写的备注和metadata。

说明

说明是用户创建应用时,给应用所做的描述,后台不可更改。

key记录:

仅显示key上限额和当前数量,要改变限额需要到名称(管理)中去操作。

开发者

显示全部开发者列表,同时管理员也可以创建开发者账号,如下图所示:

新建开发者账号:管理员可以创建开发者账号,但若想成为api提供者,需创建开发者后再申请提供者权限,如下图所示:

开发者列表:显示全部开发者信息,包含相应的操作、显示开发者账户信息、状态等。

  • api提供者:所有api提供者权限的账户信息,在此可以通过管理此权限的用户,可以禁用其发布API的权限。

  • 待审批:在此显示注册为开发者和升级为api提供者的待批申请记录,并可执行审核操作,如下图所示:

  • 已禁用:已被禁止使用的开发者账户,在此可以重新开启。

  • api申请:开发者申请成为api提供者的待审核记录,如下图所示:

消息

站点

站点:管理网站页面、菜单等站点内容,一般由前端工程师控制,如下图所示:

日志

日志:查询平台所有key的api执行调用情况,建议先填写筛选条件,然后再查询,如果没有选择查询条件,则会将当天的所有记录显示出来,所示:

集成

集成:云集成服务的入口,提供一些第三方API集成服务,通过调用api方便的接入相关服务,如下图所示:

Oauth

一种开放标准,允许第三方网站在用户授权的前提下访问用户在服务商那里存储的各种信息,用以建立有效的访客身份体系,oaut配置、监控、管理功能有以下几个部分组成:用户查询、后端参数、界面模板、登录日志、当前token,如下图所示:

  • 用户查询:在平台查询某用户是否存在,由于生产和测试的数据库是分开的,所以查询也分为生产和沙箱两个环境查询,如下图所示:

  • 后端参数:商派管理后台才有权限配置oauth的后端参数,并且可以选择几种不同的oauth模式,当设定好默认参数后,本后台管理员这里就会有默认的参数,当然也可以根据需要手动修改,如下图所示:

  • 界面模板:设置oauth服务的视图页模板及语法使用说明,如下图所示:

  • 登录日志:显示所有使用oauth服务的用户登录情况,如下图所示:

  • 当前token:显示当前oauth服务所设置的相关token信息,如下图所示:

帮助

后台给管理员提供一系列帮助文档, 以便能够快速了解和使用后台,如下图所示:

配置

包含了后台的一些基本配置功能,共有7个栏目,如下图所示:

  • 基本设置:前台名称标签的配置。

  • 开发者账号:对开发者账号注册和登录做一些限制功能,如下图所示:

  • 备份还原:备份还原平台的相关数据,如下图所示:

  • 群组:

  • 邮件发送:对邮件模板和发送场景进行设置,如下图所示:

  • 理员管理:对平台管理员的权限进行操作,同时也可以创建新的管理员账户,如下图所示:

点击“新建管理员账号”按钮后,填写账户名、密码、备注等,点击“保存”按钮,即可创建有相同权限的管理员账号,如下图所示:


沪ICP备05002918号

© 2003-2017 ShopEx,Inc.All rights reserved.