PRA2020.4 平台 API 接口调用
1. 适用版本
适用于RPA2020.4版本,RPA2020.3无API,其它版本请参考:
==> rpa9 点击跳转
==> rpa10 点击跳转
==> RPA2020.5 点击跳转
2. 接口 API 手册
调用方式及字段,请参考论坛手册:
暂未在论坛公开,请向当地厂商技术索取
3. Python 调用代码
如果想用机器人来调 API 接口,可参考以下代码,其它语言逻辑一样:部分功能接口如无法调用,请参考手册修改传参
import json
import time
import requests
from urllib import parse
import hmac
import base64
from hashlib import sha256
def rpa_rest_2020_4(host='',rest_type='',data_json=None,mode='',port=443,accesstoken=None,retry=2):
'''
host:地址,str型,示例:'https://192.168.202.11'
rest_type:str型,接口类型,示例:'/oapi/v1/job/create'
data_json:字典型,发送的报文数据json格式
mode:接口请求方式(get、post、delete及put)
port:int型,https端口
retry:int型,重试次数
返回值:get_field_json:字典型,
'''
get_field_json={'code': 40, 'msg': 'fail,意外情况','result':None}
#url参数转换
def json2Params(data_json):
get_field_json={'code': 41, 'msg': 'fail,转换URL参数失败!','result':None}
try:
data_json=json.loads(data_json)
url_str = ''
nums = 0
max_nums = len(data_json)
for key in data_json:
nums += 1
if nums == max_nums:
url_str += str(key) + '=' + str(data_json[key])
else:
url_str += str(key) + '=' + str(data_json[key]) + '&'
except Exception as e:
print('参数转化失败:',e)
url_str=''
finally:
return url_str
if mode != 'get' and mode != 'put' and mode != 'post' and mode != 'delete':
get_field_json={'code': 42, 'msg': 'fail,mode错误,只能为get、put、post或delete!','result':None}
return get_field_json
#获得签名sign
sign = ''
sign_yc = ''
url = host
if port != 443:
url = url + ':' + str(port)
url += rest_type
timestamp = None
#获取签名值sign:
try:
get_field_json={'code': 41, 'msg': 'fail,获取签名失败!','result':None}
#获得毫秒级时间戳(时间出入不能大于10分钟)
timestamp=str(int(round(time.time() * 1000)))
#处理json数据不为str类型的情况
for key in data_json:
data_json[key]=str(data_json[key])
#json排序
data_json=json.dumps(data_json,sort_keys=True)
#构造源串sign_yc
if mode == 'get':
json_str=json2Params(data_json)
sign_yc=json_str + '&token=' + accesstoken + '×tamp=' + timestamp
url = url+'?'+json_str
else:
sign_yc=str(data_json) + '&token=' + accesstoken + '×tamp=' + timestamp
print('源串:',sign_yc)
print('URL:',url)
#URL编码
url_bm = parse.quote(sign_yc, encoding="utf-8")
#sha256加密密码
byte_key = bytes(accesstoken, 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()
#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)
return get_field_json
#开始尝试发送API
print('开始尝试发送API')
for count in range(retry):
print('尝试第',count+1,'次API请求任务。')
try:
print('开始尝试:',mode)
#post、delete、put
if mode!='get':
header_dict = {'Content-Type': 'application/json;charset=UTF-8','accesstoken':accesstoken,'timestamp':timestamp,'signature':sign}
if mode=='post':
if rest_type == '/oapi/v1/job/create':
header_dict = {'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8','accesstoken':accesstoken,'timestamp':timestamp,'signature':sign}
json_str=json2Params(data_json)
url = url+'?'+json_str
res = requests.post(url, data=str(data_json), headers=header_dict,verify=False)
else:
json_str=json2Params(data_json)
url = url+'?'+json_str
header_dict = {'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8','accesstoken':accesstoken,'timestamp':timestamp,'signature':sign}
res = requests.post(url, data=str(data_json), headers=header_dict,verify=False)
if mode=='put':
res = requests.put(url, data=str(data_json), headers=header_dict,verify=False)
if mode=='delete':
res = requests.delete(url, data=str(data_json), headers=header_dict,verify=False)
if mode=='get':
header_dict = {'accesstoken':accesstoken,'timestamp':timestamp,'signature':sign}
res = requests.get(url,headers=header_dict,verify=False)
#获取返回值
res_text=res.text
#转化成json
get_field_json=json.loads(res_text)
print('请求成功!')
break
except Exception as e:
print('请求失败:',e)
get_field_json={'code': 40, 'msg': 'fail,发送API失败!','result':None}
return get_field_json
def get_token(host='',port=443,accessKey='',secretKey='',retry=2):
'''
host:地址,str型,示例:'https://192.168.202.11'
port:int型,https端口
accessKey:str型,服务平台应用AppKey
secretKey:str型,服务平台应用AppSecret
retry:int型,重试次数
'''
get_field_json={'code': 44, 'msg': 'fail,获取token失败','result':None}
for i in range(retry):
try:
url = host
if port != 443:
url = url + ':' + str(port)
json_str='accessKey='+accessKey+'&secretKey='+secretKey
url = url+'/oapi/v1/token?'+json_str
res = requests.get(url,verify=False)
res_text=res.text
#转化成json
get_field_json=json.loads(res_text)
print('获取token,第'+str(i+1)+'次,成功')
break
except Exception as e:
print('获取token,第'+str(i+1)+'次,失败',e)
time.sleep(1)
return get_field_json
def refresh_token(host='',port=443,refleshtoken='',retry=2):
'''
host:地址,str型,示例:'https://192.168.202.11'
port:int型,https端口
refleshtoken:str型,刷新token
retry:int型,重试次数
'''
get_field_json={'code': 44, 'msg': 'fail,刷新token失败','result':None}
for i in range(retry):
try:
url = host
if port != 443:
url = url + ':' + str(port)
json_str='refreshToken='+refleshtoken
url = url+'/oapi/v1/token?'+json_str
res = requests.get(url,verify=False)
res_text=res.text
#转化成json
get_field_json=json.loads(res_text)
print('刷新token,第'+str(i+1)+'次,成功')
break
except Exception as e:
print('刷新token,第'+str(i+1)+'次,失败',e)
time.sleep(1)
return get_field_json
4. 其它平台或客户端调用
4.1 其它平台调用
按照第 3 章的逻辑自行写调用代码即可。
4.2 机器人调用
按照第 4 章添加一个全局函数,在需要调用的地方使用全局函数控件即可。
注:需要提前获取token后调用,如无第三方平台对接,获取的token可存在共享变量里,分配权限调用,参考下图:
千呼万唤始出来!!!说多了都是泪啊!
1. 你需要先获取 token,然后通过获取的 token 发送 API 指令,
2.token 默认有效期应该是 30 天
3. 如果你这边暂时没有第三方平台来申请和管理 token 的话,可以先临时存在共享变量里
是 我的 key 信息吗?