入门指南[必读]

2024-07-11 1727

1、API能力概述

       云RPA提供的API能力,可实现,通过接口调用替代手动操作,来创建RPA任务。实现自动化创建RPA执行计划、自动执行RPA任务、自动获取执行结果。多数的RPA执行结果会输出文件,多数为EXCLE、CSV文件等,通过接口获取到对应文件的下载地址后,API使用者可以解析其中的业务数据,实现自身业务。API接口的请求前缀为:https://sbappstoreapi.ziniao.com/rest/sop-openapi/,这里推荐使用SDK请求API能力,SDK下载和样例见下方内容。非SDK请求需要自行对请求数据加签,可以参考文档中第五节:【其他与语言发起http请求
       API能力分自用API和第三方API两大类。
       自用API:适用于云RPA的卖家用户自己,通过API对接的方式获取自己的店铺数据,这种对接方式不需要进行店铺授权。 主要对接流程为:
  • (1)BOSS开通API权限
  • (2)获取身份标识TOKEN
  • (3)调用接口创建RPA执行计划 
       3.1 获取RPA_ID,在RPA应用市场,找到符合业务需求的RPA,点击查看详情获取RPA_ID。【如何获取RPA_ID
       3.2 创建RPA执行计划,在RPA执行计划接口中输入,RPA_ID和要运行的参数来创建执行计划。【提交计划并创建任务接口
        这里重点区分一下API参数,和RPA运行参数,每个RPA需要的运行参数根据RPA的能力不同,参数也不同,RPA运行参数并不在API文档中体现,需调用相关接口获取运行参数。参考:如何填写RPA runWith运行参数
       第三方API:适用于服务卖家的服务商,通过API对接的方式,获取卖家的店铺数据,这种对接方式需要卖家用户将店铺授权给对应的服务商。
  • (1)注册成为开发者
  • (2)获取身份标识TOKEN
  • (3)申请RPA相关的接口权限
  • (4)进行店铺授权
  • (5)调用接口创建RPA执行计划
  • (6)查询任务状态 
  • (7)查询任务执行结果     

2、常用名词解释

  • (1)RPA
     机器人流程自动化(Robotic process automation),能够代替或者协助人类在计算机、RPA手机等数字化设备中完成重复性工作与任务。只要预先设计好使用规则,RPA 就可以模拟人工,进行复制、粘贴、点击、输入等操作,协助人类完成大量“规则较为固定、重复性较高、附加值较低”的工作。
     在云RPA的RPA市场中,可以看到目前我们已经提供的全部RPA,详情中可以查看该RPA可以完成的业务操作。接口中通常使用rpaId或scriptId标识该信息。
  • (2)平台店铺和紫鸟店铺 
     平台店铺指的是电商平台上店铺,如:亚马逊店铺,后续均以亚马逊店铺为例进行描述。紫鸟店铺,指的是用户托管到紫鸟平台的亚马逊店铺。其中亚马逊店铺和紫鸟店铺并非一一对应,同一个亚马逊店铺可以被多次托管到紫鸟平台,并在紫鸟平台有单独的店铺名称,我们称之为紫鸟店铺名。            
  • (3)卖家标识 
    卖家标识指的是,电商平台对各自店铺提供的唯一ID标识,平台店铺和紫鸟店铺间使用卖家标识作为对应关系中的关联标记。当使用API创建RPA执行计划的时候,需要通过卖家标识来指定RPA要运行的店铺有哪些。当指定的卖家标识可以匹配多个紫鸟店铺时,对应的紫鸟店铺都会运行该任务,如果多个紫鸟店铺都对应相同的亚马逊店铺 则会产生多份相同数据,可以在云RPA用户端的店铺管理中,关闭不想运行的站点。接口中通常使用sellerId标识该信息。
     如何查看卖家标识 ?   【如何查看亚马逊卖家标识】【如何查看shopee虾皮店铺的店铺ID
     如何设置紫鸟店铺的卖家标识,和关闭不想运行的站点?如下图:
 打开店铺管理,设置店铺的sellerId
将不想运行RPA的站点勾选为不存在
  • (4)站点 
             平台店铺所在的站点,如:美国站、加拿大站,创建RPA执行计划的时候需要指定要运行的店铺和站点。使用站点的英文缩写,如:美国 US【平台站点对应关系
  • (5)平台 
             店铺所属的电商平台,如:亚马逊平台。创建RPA执行计划,或查询任务执行结果的时候,会需要或返回对应信息。接口中通常使用platFormId字段标识该信息。【平台站点对应关系】。
  • (6)计划 
             通过接口执行RPA的时候,首先需要创建一个RPA执行计划,计划可以是周期性的也可以是在未来的某个指定时间的,也可以是立刻运行的。接口中通常使用 planId 标识该信息。
  • (7)任务 
             创建计划后,服务器会按计划生成RPA执行任务,如,计划为每天12点运行一次,则每天12点会生成一个任务。接口中通常使用 taskId 标识该信息。
  • (8)任务执行结果
             任务运行后,会产生任务运行结果,一个任务根据运行的RPA、店铺、站点数不同会生成多条任务执行结果。接口中通常使用 taskRecordId 标识该信息。
  • (9)成功率
             RPA的运行完全模拟人工操作,存在因网络原因、设备原因、店铺原因等情况使RPA执行失败,无法获取到数据。目前还不能保证100%获取到数据。
  • (10)重试
             RPA经过内部一定次数的自动重试仍然无法获取数据,则会返回失败信息,此时API使用者,需要根据返回的失败信息决定是否继续重试,或人工介入操作后重试。【关于RPA运行结果提示