[关闭]
@myyzs 2022-06-30T02:25:03.000000Z 字数 7279 阅读 432

第三方平台对接云助手

第三方平台

简介

实现明源其他平台与云助手平台的数据互通
1、在云助手注册平台信息
2、获取token
3、接口调用


获取token

正式:https://www.fdccloud.com/api/tenant-open/get-pt-token
预发布:https://qy-qa.fdccloud.com/api/tenant-open/get-pt-token
测试:https://qy-ci.fdccloud.com/api/tenant-open/get-pt-token

传参方式:

POST

  1. {
  2. "pt_id": "ypass",
  3. "pt_secret": "mysoft5f4ef85ca2ee0"
  4. }

参数说明:

参数名称 必须 说明
pt_id 平台id,比如ypass
pt_secret 平台secret,联系云助手团队获取

返回值

  1. {
  2. "errcode": 0,
  3. "errmsg": "ok",
  4. "data": {
  5. "access_token": "OG1wSWF5bG9TUzNheEw2RVFPWjhIaGhjbHkvRGROQkkra0doa212TFAxUmZZYklhbklqdGNzK2hSUEthTU9JS1lTbDBOWS9wQUczMzkyMnZBRlZiQ1lhRy82VVcwTzFySzh5YmFhMk45eExzbFZQRGZ6Zmdqc3h3RVFIZFE0L29hRklMNFJiVVBHRDh5ZVJ6RkdGU013PT0=",
  6. "expires_in": 7200
  7. }
  8. }

参数说明:

参数名称 说明
errcode 0:成功
access_token token
expires_in 过期时间,默认过期时间为2小时

企业搜索

正式:https://www.fdccloud.com/api/tenant-open/search-tenant?access_token=ACCESS_TOKEN
预发布:https://qy-qa.fdccloud.com/api/tenant-open/search-tenant?access_token=ACCESS_TOKEN
测试:https://qy-ci.fdccloud.com/api/tenant-open/search-tenant?access_token=ACCESS_TOKEN

传参方式:

POST

  1. {
  2. "tenant_code": "poly"
  3. }

参数说明:

参数名称 必须 说明
tenant_code 企业代码,精准匹配

返回值

  1. {
  2. "errcode": 0,
  3. "errmsg": "ok",
  4. "data": {
  5. "tenant_id": "my56a9c966df069",
  6. "tenant_code": "mysoft_ci",
  7. "tenant_name": "测试企业"
  8. }
  9. }

参数说明:

参数名称 说明
errcode 0:成功
tenant_id 云助手租户id
tenant_code 企业代码
tenant_name 企业名称

获取租户信息

接口名称 获取租户信息
请求地址 https://www.fdccloud.com/api/tenant-open/get-tenant-by-code?access_token=token&tenant_code=xxx
请求方式 GET(HTTPS)

请求参数说明

参数 是否必须 描述
access_token pt_token(平台token)
tenant_code 租户code

返回结果

  1. {
  2. "errcode": 0,
  3. "errmsg": "ok",
  4. "data": {
  5. "tenant_id": "my56a9c966df069",
  6. "tenant_code": "mysoft_ci",
  7. "tenant_name": "测试企业"
  8. }
  9. }
参数 描述
errcode 0:成功

租户列表

正式:https://www.fdccloud.com/api/tenant-open/get-tenants?access_token=ACCESS_TOKEN
预发布:https://qy-qa.fdccloud.com/api/tenant-open/get-tenants?access_token=ACCESS_TOKEN
测试:https://qy-ci.fdccloud.com/api/tenant-open/get-tenants?access_token=ACCESS_TOKEN

传参方式:

GET

返回值

  1. {
  2. "errcode": 0,
  3. "errmsg": "ok",
  4. "data": [{
  5. "tenant_id": "my56a9c966df069",
  6. "tenant_code": "mysoft_ci",
  7. "tenant_name": "测试企业",
  8. "scrm_customer_id": "92c15ba6-c472-4b22-bcd6-5d7930d6e61b",
  9. "scrm_top_customer_id": "92c15ba6-c472-4b22-bcd6-5d7930d6e61b",
  10. "scrm_authorize_guid": "92c15ba6-c472-4b22-bcd6-5d7930d6e61b",
  11. "erpapi_url":"http://ci.mysoft.com.cn:8081/fdccloud_307"
  12. }]
  13. }

参数说明:

参数名称 说明
errcode 0:成功
tenant_id 云助手租户id
tenant_code 企业代码
tenant_name 企业名称
scrm_customer_id 客户id
scrm_top_customer_id 顶级客户id
scrm_authorize_guid 授权主体id
erpapi_url 接口管家地址

创建租户

正式:https://tenants.fdccloud.com/tenant/api/create-tenant-v2?access_token=token&callback_url=xx
预发布:https://tenants-qa.fdccloud.com/tenant/api/create-tenant-v2?access_token=token&callback_url=xx
测试:https://tenants-ci.fdccloud.com/tenant/api/create-tenant-v2?access_token=token&callback_url=xx

接口名称 创建租户
请求地址 https://tenants-ci.fdccloud.com/tenant/api/create-tenant-v2?access_token=token&callback_url=xx
请求方式 POST(HTTPS)

请求包结构

  1. {
  2. "owner_area":"8",
  3. "contract_number":"LY0020191008000016",
  4. "contract_name":"中铁房地产集团(福州)有限公司",
  5. "tenant_code":"zhongtie_ci",
  6. "customer_id":"28af4f13-45d2-4443-8efb-006e7fdbd585",
  7. "customer_name":"中铁房地产集团(福州)有限公司",
  8. "admin_name":"张三",
  9. "admin_mail":"zhangs01@mingyuanyun.com",
  10. "admin_phone":"13657250918",
  11. "yzs_expire_at":"2021-09-18",
  12. "from":"erp_manager"
  13. }

请求参数说明

参数 是否必须 描述
access_token pt_token(平台token)
owner_area 区域(默认8;代表其他区域)
contract_number 合同号
contract_name 合同名称(企业名称),不能为空
tenant_code 租户代码,如:mysoft_ci【只能由字母、数字、下划线组成】
customer_id 客户GUID
customer_name 客户名称,需与客户GUID对应的企业名一致
admin_name 管理员名称
admin_mail 管理员邮件地址(用于接收租户开通的账号相关信息)
admin_phone 管理员手机号
yzs_expire_at 云助手有效期(需要大于等于今日时间)
from jf,erp_manager,tenants 分别代表接口来源交付平台,erp_manager,多租户管理平台,默认erp_manager
callback_url 开租户比较耗时,租户接口会以回调方式通知调用方

返回结果

  1. {
  2. "success": 1,
  3. "data": {
  4. "tenant_id": "my611a29d4053cd",
  5. "tenant_code": "zxl_test_3"
  6. }
  7. }
参数 类型 描述
code number 当前接口逻辑结果1-成功;非1-错误
message string 提示信息
success number 服务端框架层结果 1:成功 0:失败,对应的data为错误信息字符串
tenant_id string 租户id
tenant_code string 租户code

callback_url回调样例代码

  1. $data = [
  2. 'tenant_code'=>$tenant_code,
  3. 'success'=>$isOk,
  4. 'message'=>$err
  5. ];
  6. $curl = new Curl();
  7. //post formdata方式
  8. $ret = $curl->post($callbackurl, $data);

通讯录初始化

正式:https://www.fdccloud.com/api/tenant-open/init-address?access_token=ACCESS_TOKEN
预发布:https://qy-qa.fdccloud.com/api/tenant-open/init-address?access_token=ACCESS_TOKEN
测试:https://qy-ci.fdccloud.com/api/tenant-open/init-address?access_token=ACCESS_TOKEN

传参方式:

POST

  1. {
  2. "from": "jmpt",
  3. "tenant_code": "ywy_ci"
  4. }

参数说明:

参数名称 必须 说明
from 初始化来源,jmpt:建模平台
tenant_code 企业代码

返回值

  1. {
  2. "errcode": 0,
  3. "errmsg": "ok"
  4. }

参数说明:

参数名称 说明
errcode 0:成功

发布应用

正式:https://www.fdccloud.com/api/tenant-open/publish-app?access_token=ACCESS_TOKEN
预发布:https://qy-qa.fdccloud.com/api/tenant-open/publish-app?access_token=ACCESS_TOKEN
测试:https://qy-ci.fdccloud.com/api/tenant-open/publish-app?access_token=ACCESS_TOKEN

传参方式:

POST

  1. {
  2. "tenant_id": "my56a9c966df069",
  3. "app_name": "移动审批",
  4. "app_memo": "随时随地,轻松审批",
  5. "app_logo_url": "https://x/images/mWorkflow_640_v3.png",
  6. "openurl": "http://x/index?kindType=5",
  7. "backend_url": "http://x/settings/basic/index",
  8. "enable_visual_range_ctrl":1,
  9. "enable_auth_ctrl":1,
  10. "owner":"张三"
  11. }

参数说明:

参数名称 必须 说明
tenant_id 云助手租户id,为空时表示面向全租户的saas应用
app_name 应用名称
app_memo 应用介绍
app_logo_url 应用logo,尺寸建议640*640
openurl 应用首页地址
backend_url 应用后台地址
enable_visual_range_ctrl 是否需要做用户授权,1:需要授权 0:无需授权,默认为需要授权。此参数仅限saas应用使用
enable_auth_ctrl 是否需要做租户授权,1:需要授权才能使用 0:免费无需授权,默认为需要授权。此参数仅限saas应用使用
app_type 应用类型,0-H5应用,2-离线应用,默认为H5应用,如果为离线应用需要传此字段,应用类型确定后不可修改。此参数仅限saas应用使用
owner 应用所有者。此参数仅限saas应用使用

重要:saas应用发布后,需要云助手团队审核通过,客户才能在云助手中看到对应的应用

返回值

  1. {
  2. "errcode": 0,
  3. "errmsg": "ok",
  4. "data": {
  5. "app_code": "9001",
  6. "app_key": "third5810502b5e148"
  7. }
  8. }

参数说明:

参数名称 说明
errcode 0:成功
app_code 应用唯一标识
app_key 应用key

编辑应用

正式:https://www.fdccloud.com/api/tenant-open/edit-app?access_token=ACCESS_TOKEN
预发布:https://qy-qa.fdccloud.com/api/tenant-open/edit-app?access_token=ACCESS_TOKEN
测试:https://qy-ci.fdccloud.com/api/tenant-open/edit-app?access_token=ACCESS_TOKEN

传参方式:

POST

  1. {
  2. "app_key": "third5810502b5e148",
  3. "tenant_id": "my56a9c966df069",
  4. "app_name": "移动审批",
  5. "app_memo": "随时随地,轻松审批",
  6. "app_logo_url": "https://x/images/mWorkflow_640_v3.png",
  7. "openurl": "http://x/index?kindType=5",
  8. "backend_url": "http://x/settings/basic/index",
  9. "enable_visual_range_ctrl":1,
  10. "enable_auth_ctrl":1,
  11. "app_type":2,
  12. "download_url":"https://a.b.c/d.zip",
  13. "owner":"张三"
  14. }

参数说明:

参数名称 必须 说明
app_key 应用Key
tenant_id 云助手租户id,为空时表示面向全租户的saas应用
app_name 应用名称
app_memo 应用介绍
app_logo_url 应用logo,尺寸建议640*640
openurl 应用首页地址
backend_url 应用后台地址
enable_visual_range_ctrl 是否需要做用户授权,1:需要授权 0:无需授权,默认为需要授权。此参数仅限saas应用使用
enable_auth_ctrl 是否需要做租户授权,1:需要授权才能使用 0:免费无需授权,默认为需要授权。此参数仅限saas应用使用
app_type 应用类型,0-H5应用,2-离线应用
download_url 离线应用离线包下载地址,当创建应用时app_type=2,需要传
owner 应用所有者。此参数仅限saas应用使用

重要:saas应用更新后,需要云助手团队审核通过,客户才能在云助手中看到更新后的应用

返回值

  1. {
  2. "errcode": 0,
  3. "errmsg": "ok",
  4. "data": {
  5. "app_code": "9001",
  6. "app_key": "third5810502b5e148"
  7. }
  8. }

参数说明:

参数名称 说明
errcode 0:成功
app_code 应用唯一标识
app_key 应用key

租户应用授权

正式:https://tenants.fdccloud.com/tenant/api/modify-app-authorized?access_token=token
预发布:https://tenants-qa.fdccloud.com/tenant/api/modify-app-authorized?access_token=token
测试:https://tenants-ci.fdccloud.com/tenant/api/modify-app-authorized?access_token=token

接口名称 租户应用授权
请求地址 https://tenants-ci.fdccloud.com/tenant/api/modify-app-authorized?access_token=token
请求方式 POST(HTTPS)

请求包结构

  1. {
  2. "add_authorized_appkey":"mysoft5d36b507746b1,mysoft6116305e0b16d",
  3. "del_authorized_appkey":"mysoft61161a7750d79",
  4. "tenant_id": "my56a9c966df069"
  5. }

请求参数说明

参数 是否必须 描述
access_token pt_token(平台token)
tenant_id 租户id
add_authorized_appkey 需要进行授权的应用key,同时授权多个用,隔开
del_authorized_appkey 取消授权的应用key,同时取消授权多个用,隔开

返回结果

  1. {
  2. "success": 1,
  3. "data": "应用授权成功"
  4. }
参数 类型 描述
success number 当前接口逻辑结果1-成功;非1-失败
data string 提示信息
添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注