一、登录账号网址：https://apiconnector.guandata.com/login 输入客户编码、用户名、密码，点击登录即可。
二、配置数据库客户可以手动添加自己的数据库，也可以要求电商连接器平台管理员（电商连接器平台管理员下文简称为AC管理员）创建连接器官方维护的数据库，在首次登陆连接器平台时，建议设置一个默认数据库，点击数据库卡片中的【设为默认】按钮设置默认数据库。 AC管理员创建的数据库无需自行添加，会在“数据库管理”页面中直接展示，如下图：
客户自己的数据库需要点击【新增数据库】按钮进行添加。支持mysql和postgreSQL。
三、配置数据账户点击【数据账户管理】导航栏目，点击【新增数据账户】按钮，展示的平台列表为之前客户申报的平台，如果有缺失，请联系AC管理员确认。
以聚水潭平台为例，点击【聚水潭（非淘系）】后即可根据客户情况进行授权。不同平台的授权方式不一样，如有需要，请联系AC管理员获取更多的授权帮助。
添加数据账户成功后对应的平台会在【数据账户管理】页面展示，点击名称进入API管理页面。
在【概览】中【数据库】里配置对应的数据库，后续API的运行和API定时任务的运行会在此数据库中进行。
点击【API列表】，可以查看已经接入的所有API，如果需要更多电商平台的API，请联系AC管理员进行添加。
四、运行API(一) 运行API点击【API列表】标签页，选择某一个api，点击【接口信息】标签页，点击【运行】按钮，在【运行API】弹框中配置需要的内容，然后点击【运行】按钮。
【自定义参数】栏目：并非所有api都需要配置，没有则不需要配置，时间参数可以用时间宏配置（具体见时间宏配置：https://docs.guandata.com/product/bi/428148649269133312） 【其他配置】栏目：【切分单位】属性会跟随【自定义参数】中的特定时间参数出现（如startTime和endTime），表示会对该特定时间参数进行拆分，当配置时间内数据量大时需要注意此配置项。 【动态切分】开关：开启后【取数时间预览】收起，程序会自行动态切分数据，正常情况不开启该开关。 注意：【是否覆盖】需谨慎开启，开启则跑数时会先清空表中数据 (二) 日志查看进入【运行记录】标签页，点击【查看日志】图标进行查看
五、定时任务(一) 配置定时任务定时任务可以配置多个。 点击【API列表】标签页，选择某一个api，点击【定时任务】标签页，点击【新增定时任务】按钮，在弹框中配置定时任务内容。
必须配置的栏目为【任务名称】和【周期类型】， 【参数】一栏中的时间参数（如startTime和endTime）在不进行动态配置时，会根据【周期类型】的设置自动设值，具体数值可以在【取数时间预览】栏目中预览。 以【周期类型】为每天举例，在输入【任务名称】并选择了【周期类型】为每天后，可以再配置【时间】栏目，定时任务会在每天的这个时间开始执行。 (二) 关闭定时任务定时任务可以直接删除或者停止。 1. 删除在【定时任务】标签页中点击删除图标即可删除。
2. 停止在【定时任务】标签页中点击编辑图标，将【定时任务配置】弹框的【调度状态】开关关闭；
(三) 时间宏如果“参数”中有时间类型的参数需要动态配置的，可以使用时间宏，例如：
在时间参数里进行了配置后则以时间参数配置为准，today代表当天0点，当前配置意为：每天0点2分同步昨天0点到今天0点的数据 更多时间宏配置可参考：https://docs.guandata.com/product/bi/428148649269133312 ps：如果周期类型选了“每天”，参数配置中刚好是开始时间和结束时间这样的时间段（可能名称不一定叫开始时间和结束时间），并且“取数时间预览”中展示了具体的下次执行的具体参数，可以不用配置参数（开始时间和结束时间可以不填，系统会自动设置，如下图）
六、任务重跑有时如任务运行出错（运行API或定时任务触发），可以使用任务重跑避免重复填写任务参数
七、复制当某个api存在【复制】按钮时可以进行复制功能，客户可自定义接口。如果没有该按钮，若有需要，可以联系平台管理员进行配置（有些API平台过于复杂，不适合客户自己配置）。
八、查询在某些接口如订单，在【接口信息】标签页中存在【查询】按钮，此类接口支持非时间参数而是具体的订单号作为参数去检阅，通常会为该接口支持查询功能。获取到的数据不会被存入数据库，仅供查看。
点击【接口信息】标签页中的【查询】按钮进行查询，在弹框中会有模版查询体，替换对应的具体订单号，然后点击【查询】按钮即可。
九、BI连接AC平台数据库-白名单在BI中连接AC数据库可能会遇到如下问题：当前端口:5432无法访问，请服务器管理员确认该端口是否开启。如开启端口依然无效，管理员可更换端口，再继续尝试。
此时需要开通AC平台对BI的IP白名单，需要将BI平台的公网IP提供给AC管理员。如果客户BI环境由观远运维团队部署，可直接找观远运维团队获取BI平台的IP。
|
