跳到主要内容

接入指南

快麦ERP开放平台接入指南

如果是首次对接快麦ERP开放平台(以下简称“开放平台”)的,请先花几分钟阅读一下以下内容,谢谢配合~

  1. 自研商家如有开放平台对接需求的,与快麦ERP销售同学或实施同学确认需要对接的场景后,可联系快麦ERP销售同学或实施同学申请API权限,申请API需要提供的信息包括快麦ERP公司名称、快麦商家负责人邮箱、以及需要对接的场景描述,申请审核通过后会以邮件的方式将针对该公司账号的APP Key与APP Secret发送到申请时提供的快麦商家负责人邮箱,邮件内容请商家负责人妥善保管。

  2. 自研商家如需使用快麦ERP测试公司账号调试接口,可联系销售同学或实施同学开通测试公司账号,销售同学或实施同学将使用测试公司账号申请API权限,申请审核通过后会以邮件的方式将针对该测试公司账号的APP Key与APP Secret发送到申请时提供的邮箱。自研商家可在快麦ERP测试公司账号确认接口调通后,再切换至正式公司账号。

  3. API权限提交申请后,一般在1-3工作日内审核。申请审核通过后,如在接口调试过程中,有使用问题,可联系实施或客服去问题群让业务机器人开通,开放平台审核(格式:公司名称-开放平台审核-用户申请邮箱)。

  4. API权限申请通过后,自研商家除了在邮件中获取到APP Key与APP Secret的信息以外,还可获取到访问令牌(accessToken)与更新令牌(refreshToken)的信息,开放平台对accessToken的过期时间默认设置为30天,所以开发者在会话过期前,请尽快对接【刷新会话(必接)】接口(接口路径:API文档-基础-刷新会话(必接)),否则调用API的请求将被平台拒绝。如果会话过期,请及时联系实施或客服去问题群让业务机器人开通,开放平台刷新授权格式:公司名称-开放平台刷新授权-appKey;方可继续使用。刷新会话成功后accessToken与refreshToken信息不变,会话时间延长30天。

注意:

  1. 为了快麦商家账号的信息安全,正式公司账号的API申请邮箱需要使用快麦商家负责人的邮箱,APP Key与APP Secret信息请快麦商家自行妥善保管,商家对APP Key与APP Secret的机密负完全责任,不随意透露给任何第三方,以免造成不必要的损失!商家如果在发现或怀疑他人未经授权就使用其APP Key和APP Secret时立即通知快麦ERP;

  2. API近60天内如果无有效调用,开放平台可回收API使用权限;

  3. 通过开放平台获取的商家数据均应事先获得商家授权,该数据仅可以展现和使用于数据来源的同一卖家,不允许将数据共享于其他组织或个人使用;

  4. 调用API侵犯快麦ERP权利的,开放平台将收回接口权限。

  5. 报表/智库模块的接口为增值接口,如果需要对接和使用,请联系销售同学或实施同学获取报价与接口文档。