网站首页 > 技术文章 正文
适用版本
适用于RPA10.3以及以上版本,RPA10.3及以下版本请参考: ==>点击前进
接口API手册
调用方式及注释,请参考论坛手册:http : //support.i-search.com.cn :8088/showdoc/web/#/73?page_id=2030
1.接口签名规则
1.1标头
API请求的标头中有appkey,时间戳,签名三个参数。
- 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方法:
字符串来源=getSourceParameters(); //首先“构造源串”
字符串newSources= URLEncoder.encode(sources,“ UTF8”)
newSources =newSources.replace(“ +”,“ +”);
newSources = newSources.replace(“ *”,“%2A”);
newSources =newSources.replace(“?”,“%7E”);
1.2.3 HMAC256加密
对在第二步得到的同轴进行HMAC256编码
注:HMAC256编码的加密密码密钥为之前的appkey
1.2.4 Base64加密
在HMAC256加密之后,再进行一次Base64加密
1.2.5去掉\ r \ n特殊字符
去掉Base64加密后之后的\ r \ n,然后就得道最终的签名!
2.请求方式说明
- 得到:
标头:{'Content-Type':'application / json; charset = UTF-8'}
params:json字符串
- 邮政:
标题:无需定义Content-Type
params:json字符串
- 删除:
标头:{'Content-Type':'application / json; charset = UTF-8'}
params:json字符串
- 放:
源串生成:请参考1.2.1节“ PUT请求处理”
标头:{'Content-Type':'application / json; charset = UTF-8'}
正文:需要原始形式发送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,时间戳:
页面= 1&robotIp = x&robotName = x&robotStatus = x && size = 10&appkey = 1aadd9d5ca2942fdbe50d0b849120977×tamp = 15748219023
3.4 URL编码后:
页面%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章添加一个变量函数,在需要调用的地方使用分段函数控件即可。
猜你喜欢
- 2024-09-30 SpringCloud 远程调用为啥要采用HTTP,而不是RPC?
- 2024-09-30 程序员2022年你不懂RPC远程过程调用,RPC框架的话真的要被淘汰了
- 2024-09-30 Spring Cloud Gateway一次请求调用源码解析
- 2024-09-30 Go教程34:Go微服务间Http+Json调用
- 2024-09-30 接口测试:A13_HttpRunner_hook_01_钩子机制及用例层面的调用
- 2024-09-30 Spring 框架里的 HTTP 调用,RestTemplate 还是 WebClient
- 2024-09-30 HarmonyOS如何调用http/https接口?
- 2024-09-30 Feign : 优雅的调用 API 调用feign接口
- 2024-09-30 Spring Boot调用http接口的简单方法
- 2024-09-30 远程调用中,rpc到底比http好在哪里
你 发表评论:
欢迎- 13℃一般人不敢动系列之—基于logback的日志“规范”和“脱敏”
- 12℃MybatisPlus保姆级学习笔记(四)条件构造器Wrapper方法详解
- 12℃Spring Boot 2.5.0 发布:支持Java16、Gradle 7、Datasource调整
- 11℃聊聊:Mybatis-Plus 新增获取自增列id,这一次帮你总结好
- 10℃Web前端培训:Python与JavaScript — 哪一种最适合Web开发
- 10℃MybatisPlus介绍以及整合SpringBoot
- 10℃MyBatis-Plus自动填充新增更新时间
- 9℃「Java工具类」Apache的DigestUtils加密工具类和Base64加解密类
- 0℃未命名
- 最近发表
-
- springboot整合easyexcel实现Excel导出
- JAVA 按Excel模板导出Excel文件之 Jxls
- Java导出excel java导出Excel的三种方法
- java大牛告诉你这样导出excel更加简单高效
- Java:java五行代码实现Excel的快速导出
- Spring Boot整合EasyExcel实现对于Excel文件导出?
- 一文搞定!EasyExcel实现文件导入导出,简单实用又高效
- 程序员:超级简单导出Excel 工具,Hutool Java工具类库
- 「SpringCloud」(三十)整合EasyExcel实现数据表格导入导出功能
- Hutool Java工具类库导出Excel,超级简单
- 标签列表
-
- mybatis返回int (51)
- jsonproperty注解无效 (52)
- jtextfield (48)
- flaskrequest.data (53)
- preflight请求 (48)
- request.getheader (57)
- pomexclusion (55)
- javassh连接远程服务器 (80)
- java-jar输出日志 (71)
- mybatis.type-aliases-package (63)
- arraystoreexception (56)
- 线程池submit (67)
- sshshell (49)
- vue2props (57)
- 微信小程序form表单提交 (55)
- javabase64转图片 (55)
- javaobject转map (74)
- java接口文档生成工具 (49)
- tcpflags (59)
- 虚拟机共享文件夹在哪 (60)
- shiro设置session过期时间 (61)
- python-msimpleserver (48)
- bufferedreader.readline() (48)
- map转list对象 (50)
- resttemplate文件上传 (57)
本文暂时没有评论,来添加一个吧(●'◡'●)