文档中心

可以在文档中心找到业务说明、平台接入文档

企业接入指南

接入流程

eteams开放平台的认证开发者可通过创建应用的方式调用数据接口,对数据进行读取与操作。认证开发者、创建应用的流程如下图:

开发者认证

认证成为应用提供商,必须输入以下信息:

信息项 要求及说明
手机号码 应用提供商手机号码
营业执照号 应用提供商企业的营业执照
印业执照扫描图 应用提供商企业的营业执照扫描图
认证条件:a.拥有eteams团队

b.用eteam系统管理员身份登录open-api官网地址:https://open.eteams.cn

创建应用

开发者认证完成后,即可创建第三方微应用。微应用是eteams数据互通的载体,与数据息息相关,请开发者仔细阅读下方内容。

应用创建示例图:

基本信息:
信息项 要求及说明
应用名称 20位字符以内
应用可信域名 在该域名发起的请求才可被通过,开放平台会检查该域名是否已登记
白名单IP列表 微应用调用开放平台API时的合法列表,只有白名单内的IP才能正常调用开放API,后续IP若有修改,请及时进行列表更新
授权回调地址 用于验证应用状态变更,包括应用创建、组织架构变更
授权团队 管理员登陆开放平台时,会自动给出eteams团队名称
应用介绍 进行应用的说明
第三方应用创建完成后,需要提交审核,提交后请通知eteams客服以便及时审核
第三方应用提交审核后,点击应用名称,查看应用分配的app_key及app_secret。如图所示:

自定义事项API:

eteams开放平台支持第三方应用自定义接口,可通过应用详情页,点击查看自定 义事项的API文档。查看在eteams团队中设置的自动以参数列表,然后在调用开放API 时,即可进行相应数据的变更及获取(目前API仅开放任务的查询,第二期将开发项目、审批、表单、客户等模块的增删改查的自定义数据接口)。如图所示:

第三方应用回调设置:

eteams开放平台支持数据回调设置,可通过应用详情页,点击应用回调设置前往 配置。目前可配置任务流转的回调设置(审批、客户、项目等将于第二期开放)。如:开启任务创建回调,则在eteams系统中创建任务时,会及时通知第三方应用创建的任 务信息,第三方应用即可调用开放API,获取该任务数据。如图所示:

回调设置数据请求流程:

第三方应用提供接收eteams回调通知地址,eteams回调通知以POST形式请求,参数为json格式传输。第三方接收到请求后,解析参数,获取事项ID、模块、操作 类型,调用相应的开放API,获取数据详情。

eteams开放平台回调第三方应用,josn请求参数定义:

参数 类型 描述
name String 回调名称
corpId String corpId
appKey String appKey
appModule String API回调所属模块:
任务:task
线索:clue
客户:customer
项目:mainline
成员:user
部门:department
appType String API回调所属模块的应用类型
apiCallbackUrl String API回调地址
targetId String 事项ID
optType String 事项操作类型:
创建:create,
修改:update,
删除:delete
完成:finish

令牌获取说明

应用提供商调用开放平台API,需要先取得访问令牌access_token,然后根据业务调 用开放平台相应API,实现数据的增删改查。

获取应用令牌:
获取应用令牌步骤说明:
1.获取授权码CODE(参见”获取CODE信息”);
2.根据CODE和获取应用令牌access_token(参见”获取access_token信息”)。
注意:CODE有效时间为10分钟,且只能使用一次,access_token为2小时,建议开发者 缓存该值,到期后自动获取一次,目前不支持access_token的刷新即续期。

通讯录对接说明

eteams开放平台部分接口涉及到权限及单个人员时,需要成员eteamsUid方可进 行调用,因此第三方应用提供商需要获得开放平台的组织架构。

获取步骤:
1.获取应用令牌access_token信息;
2.获取企业部门列表,参见”查询部门列表”;
3.根据部门列表获取成员信息,参见”获取部门成员信息”.

注意:目前eteams开放平台不支持向第三方增量同步组织架构变更,为了确保获取人员一致,建议开发者预留主动同步eteams组织架构功能。

授权回调地址说明

创建应用时,测试回调地址,需要将从eteams开放平台接受到的参数值返回即可。

375257841

加入

关注我们

下载移动客户端

直接访问微博

021-50388680

sales@eteams.cn