OAS用户使用手册版本更新说明产品版本资料版本资料编号资料更新说明V16.18.201.0手册第一次发行V16.18.221、APP名称从COC改为OAS2、更新图作者资料版本日期作者审核者批准者1.02018-4-14曹玲玲目录TOC\o"1-5"\h\zOAS用户使用手册IHYPERLINK\l"bookmark0"\o"CurrentDocument"系统入口5HYPERLINK\l"bookmark2"\o"CurrentDocument"服务5HYPERLINK\l"bookmark4"\o"CurrentDocument"服务详情5HYPERLINK\l"bookmark6"\o"CurrentDocument"22订阅服务5HYPERLINK\l"bookmark10"\o"CurrentDocument"我的API5HYPERLINK\l"bookmark12"\o"CurrentDocument"获取APIKEY6HYPERLINK\l"bookmark16"\o"CurrentDocument"退订服务6HYPERLINK\l"bookmark18"\o"CurrentDocument"设置IP黑白名单6HYPERLINK\l"bookmark20"\o"CurrentDocument"日志查询6API的调用6系统入口根据以下OAS用户的门户URL，访问OAS用户界面，即API商店界面。http://ControllerIP:端口号/oas-apistorehttps://ControllerIP:端口号/oas-apistore图1-1API商店界面API”用户在未登录的情况下，只能查看所有服务，及各个服务的详情。访问“我的日志查询”界面，以及“订阅服务”操作，需要登录才能使用。用户的账号和密码，联系管理员获得。服务点击左侧菜单栏的“服务”，显示所有“已发布”的服务，如下图所示。用户可以按服务名、版本号、所有者或者分类过滤显示服务。图2-1服务服务详情点击服务的图标，进入该服务的“服务详情信息”页面，用户可以看到服务的API信息、访问服务的错误码，联系方式等信息。图2-2服务详情信息订阅服务在“服务详情信息”页面，点击“订阅”按钮，若用户未登录，则会跳转到登录界面。图2-3登录页面n若用户已经登录，并且已经订阅过该服务，显示“已订阅”。我的API点击左侧菜单栏的“我的API”，展示当前用户的订阅详情。图3-1我的API3.1.获取APIKey“我的API”主页面，点击“点击查询APIKey”按钮，弹出一个可供用户复制APIKey的弹窗，如下图：图3-2获取APIKeyn退订服务在“我的API”主页面的列表中，点击操作栏内的“退订”按钮可退订服务。设置IP黑白名单在“我的API”主页面的列表中，点击操作栏内的“IP地址黑白名单”按钮，进入“IP地址黑白名单”配置窗口，来配置IP白名单（或黑名单，两者不可一起生效）。图3-3IP地址黑白名单IP白名单：只有该名单内的IP才能访问该服务。IP黑名单：该名单内的IP都不能访问该服务，其它IP都可以访问。日志查询点击左侧菜单栏“日志查询”，进入日志查询主页面，查询当前登录用户的日志图4-1日志查询n可以通过“调用时间”、点击“展开高级条件”后设置服务名称、客服端地址、调用者名称、访问结果这些条件的组合，进行过滤查询。图4-2日志查询高级条件n点击详情栏的图标，可以显示某次调用详细情况。注意：高级条件若设置了过滤条件，则不管它是展开，还是收起，查询条件都生效。API的调用本节介绍用户调用API的方法。注意：只有用户订阅了该服务，用户才拥有这个服务的调用权。按照“22订阅服务”一节操作，例如“test”用户订阅了一个服务，点击该服务的详情界面，出现如下界面：图5-1服务详情mAPI的“接口路径”是服务的URL，点击展开接口路径下的链接，可以获取服务下API的详细信息。在调用api时，请求header中加上用户的即ikey。apikey获取方式见“3.1.获取APIKey”一节。例如，test用户订阅的“KPI计算”服务有三个API，因此test用户可以调用这三个API，可以通过postman（或者其它请求工具），使用【接口路径+API+apikey】方式使用API。访问接口：{服务的接口路径}/{API}?apikey={apikey}带参访问接口：{服务的接口路径}/{API}?apikey={apikey}&pram仁value1&pram2=value1以最后一个PUT请求为例：打开POSTMAN客户端，在地址栏左侧选择PUT请求，地址栏里面输入路径（apikey可由3.1.APIKey小节得到）：HYPERLINK"http://10.62.117.64:2480/ap"http://10.62.117.64:2480/api/pm-kpitask/v1/kpitask?apikey=E7CTGzmpjTF3pSrotVBAvjomWWuUI9po传参body选择raw，JSON（application/json），然后输入参数。最后点击Send，将会返回请求到最下面的body里面，验证该restful请求是否OK。图5-2API调用示例
本文档为【OAS用户使用手册】，请使用软件OFFICE或WPS软件打开。作品中的文字与图均可以修改和编辑，
图片更改请在作品中右键图片并更换，文字修改请直接点击文字进行修改，也可以新增和删除文档中的内容。
该文档来自用户分享，如有侵权行为请发邮件ishare@vip.sina.com联系网站客服，我们会及时删除。
[版权声明] 本站所有资料为用户分享产生，若发现您的权利被侵害，请联系客服邮件isharekefu@iask.cn，我们尽快处理。
本作品所展示的图片、画像、字体、音乐的版权可能需版权方额外授权，请谨慎使用。
网站提供的党政主题相关内容(国旗、国徽、党徽..)目的在于配合国家政策宣传，仅限个人学习分享使用，禁止用于任何广告和商用目的。
浙公网安备 33021202002483