我的应用

想调用和测试开放平台的api服务,必须要先创建应用,应用是调用api的载体,每个应用可以创建一定数量的Key,通过key和相应的秘钥进行调用,调用权限也是通过key来进行划分和识别,同时key也用以记录api调用情况;发布自有API也需要在各应用中进行操作,下面将按步骤介绍这个流程。

创建应用

开发者登录平台后,在页面顶部可以看到“我的应用”,进入“我的应用”,可以看到“添加新应用”按钮,如下图所示:

点击“添加新应用”,在此可以根据页面提示完成应用创建,应用分为网址和平台应用两种,网址需要使用app的特定的json格式地址;平台应用需要填写应用名称、和说明等,如下图所示:

创建应用后,即可在“我的应用”中看到应用列表,点击id或名称即可查看应用的详细信息,包括7个功能菜单:keys、meta、调用权限、消息队列权限、团队、统计、发布api等,如下图所示:

应用管理

生成key

为了调用api,首先要给应用创建key,平台用key来分辨每次api请求状态,并通过key来给予相应的权限。每个应用可以生成的key总数是由后台限制的,详情见“后台应用”管理。进入应用后,首先进入“keys”,点击“添加新key”,如下图所示:

在“添加新key”页面,需要设定有效期(可使用默认值也可自定义),以及key的说明,metadata、value是限定key的参数和值,根据需要填写,如下图所示:

填写完成后,点击“生成新key”按钮,则可成功生成一个key,并同时生成相应的secret,如下图所示:

就此,我们完成了应用和key的创建。

key管理

  • 基本信息:包含所属应用id,key、secret、创建时间(在key列表显示)、有效期等信息等基本信息;也可以添加说明备注,限制key使用的meta及其value根据开发者需要自行填写;删除key操作也可以直接在此执行,但删除前要考虑它已经调用API数据是否会造成不良影响,如下图所示:

  • 消息队列:api在执行时需要在用户和平台服务器之间进行通信,有些api服务并发量会比较大,当服务器不能承受负载时,将通过mq消息机制去处理,将信息放在队列中通过路由来处理,所以此处的消息队列便是查看和设置该key下的mq消息使用,根据开发者的需求自行填写。

消息管理包含队列条目、消息概览、事件绑定、当前连接、发送消息、查看消息、清空队列等功能,如下图所示:

在此对各功能做简单介绍:

队列条目:以秒为单位记录队列中的消息数量,用流量方式展现。

Message概览:包含了message基本情况和速率统计等。

事件绑定:设置消息名称和所用路由。

当前连接:目前用户与服务器的通信连接情况记录。

发送消息:给本队列发送消息。

拾取并查看消息:设置丢弃消息的数量。

一键清空队列:有不需要的队列消息,则可通过此按钮进行删除。

  • 日志:查询该key的api执行调用情况,若不写筛选条件,则是查询当天的全部内容,也可根据需要填写筛选条件后再查询;根据日志可以查看调用参数、返回情况、报错信息等,如下图所示:

Meta

暂无作用,如下图所示:

调用权限

由后台控制,限定该用户可以调用的API范围,允许调用的则会出现在这个列表中,并且调用频次受到限制,如下图所示:

消息队列权限

显示在mq系统的消息队列是否有接收和发送的权限,如下图所示:

消息队列权限配置方式目前只能使用调用api的方式进行配置,通过后台管理员子在个人中心中,选择app管理,选择“配置消息路由“和”配置可消费消息路由“这两项分别设置消息“可接收”和“可发送”的权限,如下图所示:

团队

管理其它用户对自己创建的API服务的使用权限(分为三种:只读、可编辑、超级管理),如下图所示:

统计

按时间维度统计本应用每日API执行次数,仅显示最近一个月的调用情况,单日统计方法为按API或按Key显示,如下图所示:

发布API

您可以发布自己的api接口,自用或分享给其他人调用,只有api提供者才有这个权限,有两种模式发布API服务,分为导入API定义json和平台创建,在此将分别介绍两种api发布方法,如下图所示:

  • 网址导入api方式:先填写要导入的api的json格式地址,点击“下一步”按钮,如下图所示:

导入成功提示如下图所示:

此时该应用便成功导入一个外网api,点击左下方的“返回api列表”,即可看到此api服务已经可以使用了,如下图所示:

点击该api名称,可以看到api相关的管理信息,各功能说明将在后面的“平台发布api”进行叙述,本方式和第二种方式有一个区别之处在于,网址导入方式可以进行本地化操作,但是本地化之后,如果外部api有更新的话,本地api将不会被更新,如下图所示:

  • 平台发布api方式:首先点击“创建api描述文件”按钮,有两种方式填写api信息,第一种为普通编辑器,根据页面提示填写相关信息,如下图所示:

第二种为json文本编辑模式,直接将信息用代码的方式写入,如下图所示:

完成信息填写后,点击右上方的保存,即可生成自己的api;刚发布的api是处于下线状态,需要申请上线并由后台同意后,才可以出现在api列表中,如下图所示:

api申请上线或下线需要后台审核,通过后才能生效,后台审核时,在api中点击“申请上线”,可以看到申请记录,如下图所示:

审核成功后,开发者即可在api列表中看到发布成功的api服务,如下图所示:

管理自己的api

发布成功的api,将拥有多个相关功能,在此按照功能菜单做一一介绍(每个账户只能发布1个api,每个api可以创建多个方法),如下图所示:

  • 信息:显示该api的json地址、调用地址、后端服务地址、沙箱地址等,还有“申请上线”、“申请下线”按钮,也可查看当前发布的版本。

  • 编辑:修改api信息、创建方法等等,依然有普通编辑和json编辑两种模式,并且可以选择要编辑的版本,修改完成后点击保存即可,上线的api也可以编辑,如下图所示:

  • 后端:查看后端服务地址、修改后端参数(初始参数为发布api时所写),修改参数后点击“保存设定”按钮即可,如下图所示:

  • 团队:设置其他用户对本账户发布的api拥有相关权限,点击“添加新成员”按钮,即可如下图所示:

填写其它开发者用户名并选定权限后,点击“保存”按钮即可。目前权限分为三种,分别是:readonly、write、owner,如下图所示:

  • 统计:以日为单位,统计最近一个月该api被执行的次数,分为按方法和按调用者两种,按方法是按照api所包含的各方法做分别统计,按调用者则是按照开发者账户id做分别统计。

  • 历史:显示用户对该api的基本操作日志,日志的记录字段有版本号、用户名称、时间点、操作、结果备注等,其中操作内容有查看、编辑、申请上下线等,以时间排序记录相关操作历史。

  • 群组:显示该api下有哪些api方法,如下图所示:

  • 日志:查询该api执行调用情况,必须先填写筛选条件,然后再点击“查询”按钮,若没有选择查询条件,则会将当天的全部日志查询出来,如下图所示:


沪ICP备05002918号

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