PRA10.3 平台 API 接口调用
适用版本
适用于RPA10.3以及以上版本，RPA10.3及以下版本请参考： ==> 点击跳转
接口 API 手册
调用方式及字段，请参考论坛手册：
http://support.i-search.com.cn:8088/showdoc/web/#/73?page_id=2030
1. 接口签名规则
1.1 Headers
API 请求的 Headers 中有 appkey，timestamp，signature 三个参数。
- appkey 与服务端管理员联系获取（系统 - 系统设置 - 应用接口中获取）。
-
timestamp 是当前请求的时间戳（毫秒）。
-
signature 是接口签名认证，具体签名规则参考下一下节
1.2 接口签名认证
1.2.1 构造源串
把所有请求参数，按照字典升序排列，即：原先为 {”b”:”b”,”a”:”a”,”c”:”c”｝, 排序后为 {”a”:”a”,”b”:”b”,”c”:”c”｝
- POST/GET /DELETE 请求处理
将排序后的 json 参数 (key=value) 用 & 拼接起来，即：a=a&b=b&c=c
- PUT 请求处理
将排序后的 json 参数转化成 str，即：’ {”a”:”a”,”b”:”b”,”c”:”c”}’
经过排序过后的仅仅是源串的一部分，还要在它的基础上按顺序加上 appkey，timestamp，
参考示例：
‘a=a&b=b&c=c&appkey=1aadd9d5ca2942fdbe50d0b849120977×tamp=1574821902392’
或
‘{”a”:”a”,”b”:”b”,”c”:”c”}&appkey=1aadd9d5ca2942fdbe50d0b849120977×tamp=1574821902392’
1.2.2 URL 编码
在第一步“构造源串”中得到的字符串，在此步骤中用来 URL 编码!
除了用普通方法来 URL 编码外，还有几个字符需要特殊处理。
Java 方法：
String sources =
getSourceParameters(); // 第一步“构造源串”
String newSources
= URLEncoder.encode(sources, “UTF8”)
newSources =
newSources.replace(“+”, “+”)；
newSources = newSources.replace(“*”, “%2A”)；
newSources =
newSources.replace(“~”, “%7E”)；
1.2.3 HMAC256 加密
对在第二步得到的字符串进行 HMAC256 编码
注：HMAC256 编码的加密密码 key 为之前的 appkey
1.2.4 Base64 加密
在 HMAC256 加密之后，再进行一次 Base64 加密
1.2.5 去掉 \r\n 特殊字符
去掉 Base64 加密后之后的 \r\n，然后就得道最终的签名!
2. 请求方式说明
- GET：
Headers：{‘Content-Type’: ‘application/json; charset=UTF-8’}
params:json 字符串
- POST：
Headers：每种接口都可能不同，参考代码
params:json 字符串
- DELETE：
Headers：{‘Content-Type’: ‘application/json; charset=UTF-8’}
params:json 字符串
- PUT：
源串生成：请参考 1.2.1 节“PUT 请求处理”
Headers：{‘Content-Type’: ‘application/json; charset=UTF-8’}
Body: 需要 raw 形式发送 json 信息
3. 签名生成示例：
3.1 源串
robotName=x&robotIp=x&robotStatus=x&page=1&size=10
3.2 排序后：
page=1&robotIp=x&robotName=x&robotStatus=x&&size=10
3.3 加上 appkey，timestamp：
page=1&robotIp=x&robotName=x&robotStatus=x&&size=10&appkey=1aadd9d5ca2942fdbe50d0b849120977×tamp=15748219023
3.4 URL 编码后：
page%3D1%26robotIp%3Dx%26robotName%3Dx%26robotStatus%3Dx%26%26size%3D10%26appkey%3D1aadd9d5ca2942fdbe50d0b849120977%26timestamp%3D15748219023
3.5 HMAC256 加密：
37f3d9ec02bff028f364e4c99050ecf50a352be2ede3d69c3e71abbbb73ec328
3.6 Base64 加密：
MzdmM2Q5ZWMwMmJmZjAyOGYzNjRlNGM5OTA1MGVjZjUwYTM1MmJlMmVkZTNkNjljM2U3MWFiYmJiNzNlYzMyOA==
3.7 获得签名
对上一步获得的字符串进行处理，去掉 \r\n：
MzdmM2Q5ZWMwMmJmZjAyOGYzNjRlNGM5OTA1MGVjZjUwYTM1MmJlMmVkZTNkNjljM2U3MWFiYmJiNzNlYzMyOA==
这个就是最终的接口签名值，需要 header 在里面传递!
4. Python 调用代码
如果想用机器人来调 API 接口，可参考以下代码，其它语言逻辑一样:
import json
import time
import requests
from urllib import parse
import hmac
import base64
import io
from hashlib import sha256
def rpa_rest_10_2(host,rest_type,data_json,appkey,mode='get',port=10080,try_times=2):
'''
host:地址，str型，示例：'http://192.168.202.150'
rest_type:str型，接口类型，示例：'/api/v2/jobs'
data_json:字典型，发送的报文数据json格式
appkey:str型，服务平台应用Key
mode:接口请求方式（get、post、delete及put）
port:int型，http端口
try_times:int型，重试次数
返回值：get_field_json:字典型，
'''
count = 0
rpa_files =False
get_field_json={'code': 4, 'msg': 'fail,发送API消息遇到严重错误！','result':None}
if mode != 'get' and mode != 'put' and mode != 'post' and mode != 'delete':
get_field_json={'code': 40, 'msg': 'fail,mode错误,只能为get、put、post或delete！','result':None}
#获得签名sign
sign=''
try:
#源串:sign_yc
#获得毫秒级时间戳（时间出入不能大于10分钟）
timestamp=str(int(round(time.time() * 1000)))
sign_yc=''
#处理json数据不为str类型的情况
for key in data_json:
print(type(data_json[key]))
if isinstance(data_json[key],io.TextIOWrapper):
rpa_files=True
print('有文件流！')
else:
data_json[key]=str(data_json[key])
#json排序
data_json=json.dumps(data_json,sort_keys=True)
if mode == 'put':
sign_yc=str(data_json) + '&appkey=' + appkey + '×tamp=' + timestamp
url = host + ':' + str(port) + rest_type
else:
#生成源串
if rest_type != '/api/v2/jobs':
json_str=str(data_json).replace('": "', '=')
json_str=json_str.replace('", "', '&')
json_str=json_str.replace('{"', '')
json_str=json_str.replace('"}', '')
sign_yc=json_str + '&appkey=' + appkey + '×tamp=' + timestamp
url = host + ':' + str(port) + rest_type + '?' + json_str
else:
sign_yc=data_json + '&appkey=' + appkey + '×tamp=' + timestamp
url = host + ':' + str(port) + rest_type
print('源串：',sign_yc)
print('URL:',url)
#URL编码
url_bm = parse.quote(sign_yc,'utf-8')
print('URL编码:',url_bm)
#sha256加密密码
byte_key = bytes(appkey, encoding="utf-8")
byte_url_bm = bytes(url_bm, encoding="utf-8")
hn256 = hmac.new(byte_key, byte_url_bm, digestmod=sha256)
hh256 = hn256.hexdigest()
print('256加密:',hh256)
#Base64编码
bb64 = base64.b64encode(bytes(hh256, encoding="utf-8"))
#获取sign
sign = str(bb64, "utf-8")
#替换\r\n
sign=sign.replace('\r\n', '')
print('签名值sign：',sign)
except Exception as e:
print(e)
#开始尝试发送API
print('开始尝试发送API')
while True:
try:
header_dict = {'appkey':appkey,'timestamp':timestamp,'signature':sign}
print('尝试第',count+1,'次请求任务。')
try:
print('开始尝试',mode)
if mode=='post':
if rest_type == '/api/v2/jobs':
header_dict = {'Content-Type': 'application/json; charset=UTF-8','appkey':appkey,'timestamp':timestamp,'signature':sign}
#body要raw形式发送
res = requests.post(url, data=str(data_json), headers=header_dict)
elif rpa_files == True:
print('还未配置，有时间再添加')
else:
res = requests.post(url, data=json.dumps(data_json), headers=header_dict)
if mode=='get':
res = requests.get(url,headers=header_dict)
if mode=='put':
header_dict = {'Content-Type': 'application/json; charset=UTF-8','appkey':appkey,'timestamp':timestamp,'signature':sign}
#body要raw形式发送
res = requests.put(url, data=str(data_json), headers=header_dict)
if mode=='delete':
res = requests.delete(url, data=json.dumps(data_json), headers=header_dict,verify=False)
print('尝试成功')
except Exception as e:
print('打印错误日志：',e)
#获取返回值
res_text=res.text
#转化成json
get_field_json=json.loads(res_text)
print('请求成功！')
break
except Exception as e:
print('尝试失败：',e)
time.sleep(1)
finally:
count += 1
if count >= try_times:
break
print('返回值json：',get_field_json)
return get_field_json
5. 其它平台或客户端调用
5.1 其它平台调用
按照第 4 章的逻辑自行写调用代码即可。
5.2 机器人调用
按照第 4 章添加一个全局函数，在需要调用的地方使用全局函数控件即可。
PRA？标题错了