概述

API接口概述

由于目前市面上自动化工具较多,为了适应友商多元化的接入场景,特意开放公共API以供自动开区工具使用,API接口是其他系统与本系统交互最方便的途径。

API接口请求方式只支持POST。

API接口请求全部按Api统一请求参数组合成Json格式提交。

API接口地址默认为http://api.xx.com,合作方接入时,建议采用配置方式,避免由于不可变因素引起平台更换接口域名。



Api统一请求参数

参数名 必填 类型 示例值 描述
iversrion String V1.0 API接口的版本号
iuserid Int 1169 平台的用户ID
itype String grouplist 接口类型标识,详见各接口详情
idata JsonArray {"groupid":"1001","groupname":"测试分组"} 接口数据包,JsonArray格式,参数列表见各接口参数详情
isign String e10adc3949ba59abbe56e057f20f883e 接口校验签名,32位小写md5串,详见签名规则

例如,获取所有分组列表-举例如下:


                        

提交签名规则

签名校验原串为:{iversrion}{iuserid}{itype}{apikey)

例如ApiKey为:IcQq3xvVwNoqlJmVtlNouaSPtLIxM6ni

如以上示例中组合为:1.01169grouplistIcQq3xvVwNoqlJmVtlNouaSPtLIxM6ni

生成MD5签名为:a8eded2d1a30ded913aacf64427106e5



Api统一返回值

参数名 必填 类型 示例值 描述
resultcode Int 200 请求状态代码,200:操作成功,201:业务失败,500:异常
resultmsg String 创建分区失败 请求状态说明,中文描述
resultdata JsonArray {"groupid":"1001","groupname":"测试分组"} 接口返回数据包,JsonArray格式,参数列表见各接口返回参数详情
sign String e10adc3949ba59abbe56e057f20f883e 接口校验签名,32位小写md5串,详见签名规则

举例如下:


                        

返回签名校验

签名校验原串为:{userid}{resultcode}{apikey)

例如ApiKey为:IcQq3xvVwNoqlJmVtlNouaSPtLIxM6ni

如以上示例中组合为:1169200IcQq3xvVwNoqlJmVtlNouaSPtLIxM6ni

生成MD5签名为:424a3d65bd93d46057dee705d2ca9f93



APIKEY说明

获取方式:登录平台 -> 通讯密钥页面。

由于接口权限较高,拥有删除分区、修改分区等功能,所以请保管好APIKEY,并经常更换,分组、分区等数据丢失后,无法找回。