更新时间:2024-07-05 GMT+08:00
分享

对接联营Kit同步接口

前提条件

基础接口和Kit接口合计10个接口的生产地址路径保持一致。

  • 基础接口:新购商品、商品续费、商品过期、商品资源释放、商品升级。
  • Kit接口:租户信息同步接口、租户应用信息同步接口、租户应用授权信息同步接口、组织部门信息同步(增量)、组织部门信息同步(全量)。
接口URL定义规则是生产地址+固定子路径。每个接口的子路径是固定的,每个接口对应的固定子路径为:

接口

路径

租户信息同步接口

/produceAPI/tenantSync

租户应用信息同步接口

/produceAPI/applicationSync

租户应用授权信息同步接口

/produceAPI/authSync

组织部门信息同步(增量)

/produceAPI/singleOrgSync

组织部门信息同步(全量)

/produceAPI/allOrgSync

联营Kit接口描述请参见《云商店 接入指南》联营Kit接口描述

请求参数场景说明

租户信息同步接口/租户应用信息同步接口/组织部门信息同步(增量):

若接口请求参数的“flag”字段删除、修改或新增,服务商需要实现删除、修改或新增租户信息的业务逻辑。自测用例请参见云商店购买SaaS类应用绑定

租户应用授权信息同步接口:

  1. 若接口请求参数的“flag”字段删除、修改或新增,服务商需要实现删除或新增租户信息的业务逻辑。自测用例请参见云商店购买SaaS类应用绑定
  2. 下述两个场景需要用到扩展字段extension功能:
    • ERP类应用,涉及到多账套的需通过扩展字段extension来传账套信息。
    • 非ERP类应用,如果需要同步user扩展字段(如手机号、工号、邮箱等字段),可通过扩展字段来进行扩展传参,ISV端需要提前做好对接逻辑。扩展字段详细操作请参考企业租户将应用授权给下属的用户中的ERP类应用多账套或者扩展字段传参流程
  3. 租户应用授权信息同步时,需要根据用户信息userList中的role参数描述的逻辑进行处理。
    role字段有admin、user的区分,测试时与租户手机号相同的用户作为admin角色,其它用户作为user角色:
    • admin:role传到第三方应用下游,该用户在平台进入应用时默认有管理员的权限。
    • user:role传到第三方应用下游,该用户在平台进入应用时默认有用户的权限。

组织和账号同步说明

组织部门信息同步(增量)/组织部门信息同步(全量):

  1. 组织同步说明:
    • 应用有组织部门

      ISV应用中如果每个用户都有单独的组织,即整个租户下的组织是树形结构,每个用户都挂在各自的组织下,则需要做组织的同步。

    • 应用无组织部门

      ISV应用中如果每个用户都挂在一个根组织下,即没有组织结构,组织不做对接就可以,同步组织事件做一个“伪通过”即可。

  2. 存量组织、账号同步说明:
    • 应用涉及存量组织、账号同步

      ISV应用本身有存量的组织、用户,若涉及旧数据迁移到MIW新平台,就需要考虑存量组织、用户同步的场景。

    • 应用不涉及存量组织、账号同步

      ISV应用本身无存量的组织、用户,若不涉及旧数据迁移到MIW新平台,就无需考虑存量组织、用户同步的场景。

    应用中的存量组织数据迁移,应用程序根据如下流程处理:

    应用中的存量用户数据迁移,应用程序根据如下流程处理:

相关文档