第三方同步标准接口(1).pdfVIP

一、接口内容 同步接口提供组织、项目、人员三类数据的同步，接口调用时需按先组织同步、再项目 同步、最后用户同步顺序执行。 针对无需同步第三方组织，只需同步人员的情况，可以按下面步骤同步： 1、先调用组织同步接口，同步一个虚拟的第三方根组织，同步时需要保证虚拟第三方 根组织名称和平台租户的根组织名称相同。此步骤主要建立第三方根组织与平台根 组织的映射关系。 2、调用第三方用户同步接口，传递同步虚拟第三方根组织时指定的 rootId，其他信息 按接口要求传递即可。此时会将第三方用户同步到平台的根组织下。 二、接口域名 1、测试环境： 2、正式环境： 三、接口调用 1、注册租户同步配置信息 目前需要接口调用方提供如下表格信息，由CloudtT 完成配置信息注册，同时给调用方 颁发cloudt-x-trd-access-id。 注意：在提供信息时需要明确是测试环境还是正式环境。 参数名称 参数描述 参数提供方 trdTenantId 第三方租户标识。每个租户必须唯一 第三方提供 source 来源。一般按产品来源定义，如geps 产 第三方提供 品 ，定义为 external.geps。 TenantId 平台租户Id。与第三方租户标识一一对 第三方提供。可以联系实 应。标识需要将数据同步到平台哪个租 施确认该参数值。 户下面。 2、调用接口 调用接口前，必须完成租户同步配置信息的注册。然后按照接口调用认证方式和接口调 用公共参数说明对接口调用时进行设置。 1) 接口调用认证方式 接口调用采用请求认证方式，接口调用时需增加如下请求头： 参数名称 值 cloudt-x-rest-auth-type 固定值：trd cloudt-x-trd-access-id 平台颁发的与每个租户对应的标识。Cloudt 平台提供 2) 接口调用公共参数 接口调用时公共参数，如下表所示： 参数名称 参数描述 参数提供方 trdTenantId 第三方租户标识。每个租户必须唯一 第三方提供，注册配置信 息时指定的值 source 来源。一般按产品来源定义，如geps 产 第三方提供，注册配置信 品 ，定义为 external.geps。 息时指定的值 adapterType 适配器类型，固定值 BASE_ADAPTER 四、同步接口详情 1、第三方用户同步接口 请求地址： 接口域名/sync-api/v3/service/public 请求方法： POST 同步说明： 1、手机、邮箱必填一个。如果手机号和邮箱同时存在，优先使用手机号匹配，其次 邮箱。 2、如果orgRoles 为空，再完成用户信息的新增、修改操作后，会将用户设置在第三 方根组织下。 3、 orgRoles 不为空且roles 为空时，再完成用户信息的新增、修改操作后会将用户 设置到第三方组织Id 所在组织下,但没有产品角色。 4 、roles 不为空时，code 要与平台的roleId 对应，否则找不到角色，无法处理 5、一个用户失败不会影响整个同步执行，会将失败的用户记录下来 6、操作类型 operation 说明 人员操作 ：UPDATE、DELETE。角色操作：ADD、DELETE 可以不填写。人员默认为Update 操作，角色默认Operation 是Add 。 7、必填项说明 用户账号、手机、邮箱必填一个。其他见请求数据包说明中标红部分内容。 8、全量同步说明