5.1API概述
5.1.1API文档

平台对外提供的服务形态为类REST(也可以叫做RPC形态)。RPC形态其实就是Web Service的一种延续,只是少了繁重的解析、安全规范等,作为一种轻量级服务交互规范得到了新一代互联网企业的认同。这样的服务形态就可以很容易地从浏览器或移动设备调用它们。

服务请求就是标准的Http的请求。编码方式采用UTF-8编码,返回结果统一采用JSON格式。

如服务请求地址:http://10.110.16.38/devweb/api/cataLog_4cb5bab3365c4e729c6bab94c3d470d4/get_datalist_page/1.0?client_id=5657&client_secret=d2b4c8dfc78c289ce82cf927a25cc11e&SIZE=8&START=1

参数名称参数说明
服务上下文必选参数,服务唯一标识。即示例中的“/cataLog_4cb5bab3365c4e729c6bab94c3d470d4/get_datalist_page”
版本号必选参数,即示例中的“1.0”
所属应用ID,应用密钥必选参数,代表应用的身份和可访问服务的权限列表。即示例中的“client_id=5657&client_secret=d2b4c8dfc78c289ce82cf927a25cc11e”
业务参数必选参数,访问服务必须需要的业务参数。如“SIZE=8&START=1”
5.1.2API使用规范

为了更好的保障线上应用有良好的用户体验,请开发者按照此规范对开放平台API进行合理使用。若因违规调用相关API导致用户体验受到不良影响,警务云计算中心将有权按照相应处理办法对违规调用接口的应用进行处理。

API使用规范

1. 所有接口均需按照开放平台接口的描述进行使用,详细描述可参见开放平台API列表

2. 开发者对于用户信息类接口需谨慎使用,不得将用户信息用于除应用功能所需之外的一切用途。

3. 开发者在使用日志、状态类接口时需让用户确认,不得在用户不知情的情况下以用户身份进行发布。接口调用通过审核后将不得随意更改,若要更改则需进行申请。

4. API使用规范包含但不限于以上三条,任何影响用户体验、网站安全的功能都将被视为违规情况。

API违规调用处理办法

1. 开发者通过用户信息类接口调用用户信息用于除应用功能之外的其他用途或属作恶应用,一经发现立即对该应用进行下线处理。应用相应功能修改完毕后可再次向平台申请上线。如果该应用属于再次违规将不得再次申请上线。

2. 对于日志、状态、通知类等接口违规调用,平台将第一时间通知该应用开发者进行整改,同时视对用户体验影响程度大小对该接口进行暂停使用或频率限制。调整完毕之后可申请恢复使用违规调用接口。此外,开放平台有权对违规应用进行公告。

3. 申请邮件标题统一为“应用“***”申请开通违规调用接口”,邮件内容注明APP id、APP名称、违规事项、解决方案及修复日期。

API调用错误码

API调用错误响应中的错误码定义如下表所示:

错误码(errorcode)错误描述(error description)
40150缺少必要的请求参数
40160应用id不存在、请求授权过程应用id不一致
40201访问令牌access_token无效或者过期
40202无权限访问,所申请的访问令牌不包含当前接口的授权,需求申请该服务并重新获取访问令牌
40203无效的API,无此API接口
40204服务调用频繁,超出所申请的服务级别