Automaiton360的API接⼝能⼒
控制台提供了完整的API交互能⼒,⽀持机器⼈排产,⽤户管理,仓库管理,设备管理,⽇志查询等业务操作。
控制台对RESTAPI的⽀持
控制台API⽀持的是REST⽅式的JSON调⽤,原理上利⽤HTTP的GET,POST,PUT, DELETE⽅法,对业务操作调⽤进⾏响应。控制台提供swagger标准的接⼝列表,每个API接⼝会与具体的调⽤的⽅法,状态响应和样例消息体。其访问路径为
更详细的调⽤样例请参阅⽂档
控制台API调⽤列表
*注: 社区版仅提供有限的API调⽤能⼒
调⽤API需要的安全令牌
除Authentication外所有的API调⽤都需要附有安全令牌,安全令牌通过Authentication API产⽣。安全认证可以通过⽤户名和密码,或⽤户名和APIKEY进⾏认证。安全令牌的默认失效时间为20分钟,失效后安全令牌需要⽤重新⽣成。
调⽤过程如下
Post请求,
{
"username":"jdoe",
"password":"mypassword@123"
}
回复为,
{
"token":
"eyJzdWIiOiIxIiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbXSwiYW5hbHl0aWNzTGljZW5zZXNQdXJjaGFzZWQiOnsiQW5hbHl 0aWNzQ2xpZW50Ijp0cnVlLCJBbmFseXRpY3NBUEkiOnRydWV9LCJpYXQiOjE1NzMxMDc4NzMsImV4cCI6MTU3MzEwOTA3Mywi aXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjM2NTc1NjI0OTQ2MzE2MDAsImNzcmZUb2tlbiI6ImNiZjgwZWNkZmU5 YmUwYzViOGI2MDk3NmU0ZTI2MTNiIn0”
"user":xxxxx
百度api接口…….
}
调⽤⾮Authentication API 时必须附上 X-Authorization header : <;认证返回的安全令牌值>,否则会提⽰认证异常。
利⽤⼯具调⽤控制台API的样例
⽤户认证返回安全令牌
将令牌嵌⼊header再调⽤部署流程
控制台操作所涉及到的API
需求上可能要实现和控制台相同操作的API调⽤,相⽐翻⽂档,更快捷的⽅式可以打开浏览器F12的调试模式,查看业务操作所涉及的API调⽤接⼝。例如通过控制台界⾯排产机器⼈流程。
调试模式下的请求格式与Header信息。
变量类型对应的API请求格式
可以通过控制台的调试模式获取各种格式变量的请求格式记录如下
"字符变量":{"type":"STRING","string":"输⼊字符串"}
"数字变量":{"type":"NUMBER","number":"666"}
"⽇期时间变量":{"type":"DATETIME","string":"2021-03-31T00:00:00+08:00[Asia/Shanghai]"}
"布尔值变量":{"type":"BOOLEAN","boolean":true}
"列表变量":{"type":"LIST","list":[{"type":"STRING","string":"列表值1"},{"type":"STRING","string":"列表值2"}]}
"字典变量":{"type":"DICTIONARY","dictionary":[{"key":"键1","value":{"type":"STRING","string":"值1"}},{"key":"键2","value": {"type":"STRING","string":"值2"}}]}
"数据表变量":{"type":"TABLE","table":{"schema":[{"type":"STRING"},{"name":"","type":"STRING"},{"name":"","type":"STRING"}],"rows": [{"values":[{"type":"STRING","string":"11"},{"type":"STRING","strin
g":"12"},{"type":"STRING","string":"13"}]},{"values": [{"type":"STRING","string":"21"},{"type":"STRING","string":"22"},{"type":"STRING","string":"23"}]},{"values": [{"type":"STRING","string":"31"},{"type":"STRING","string":"32"},{"type":"STRING","string":"33"}]}]}
获取流程调⽤的返回值
流程部署的API调⽤后会获取到流程的部署ID。通过部署ID可以调⽤/v2/activity/list,查询机器⼈流程状态与返回信息。
调⽤请求,
{
"filter": {
"operator": "eq",
"field":"deploymentId",
"value":"89c120ff-c4ba-4bf7-88b0-a59a7d03e1dc"
}
}
逻辑上需要判断返回的Status字段为COMPLETE,然后获取botOutVariables的具体字段值