@myyzs
2022-06-30T02:25:03.000000Z
字数 7279
阅读 432
第三方平台
实现明源其他平台与云助手平台的数据互通
1、在云助手注册平台信息
2、获取token
3、接口调用
正式: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
{
"pt_id": "ypass",
"pt_secret": "mysoft5f4ef85ca2ee0"
}
参数说明:
参数名称 | 必须 | 说明 |
---|---|---|
pt_id | 是 | 平台id,比如ypass |
pt_secret | 是 | 平台secret,联系云助手团队获取 |
返回值
{
"errcode": 0,
"errmsg": "ok",
"data": {
"access_token": "OG1wSWF5bG9TUzNheEw2RVFPWjhIaGhjbHkvRGROQkkra0doa212TFAxUmZZYklhbklqdGNzK2hSUEthTU9JS1lTbDBOWS9wQUczMzkyMnZBRlZiQ1lhRy82VVcwTzFySzh5YmFhMk45eExzbFZQRGZ6Zmdqc3h3RVFIZFE0L29hRklMNFJiVVBHRDh5ZVJ6RkdGU013PT0=",
"expires_in": 7200
}
}
参数说明:
参数名称 | 说明 |
---|---|
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
{
"tenant_code": "poly"
}
参数说明:
参数名称 | 必须 | 说明 |
---|---|---|
tenant_code | 是 | 企业代码,精准匹配 |
返回值
{
"errcode": 0,
"errmsg": "ok",
"data": {
"tenant_id": "my56a9c966df069",
"tenant_code": "mysoft_ci",
"tenant_name": "测试企业"
}
}
参数说明:
参数名称 | 说明 |
---|---|
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 |
返回结果
{
"errcode": 0,
"errmsg": "ok",
"data": {
"tenant_id": "my56a9c966df069",
"tenant_code": "mysoft_ci",
"tenant_name": "测试企业"
}
}
参数 | 描述 |
---|---|
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
返回值
{
"errcode": 0,
"errmsg": "ok",
"data": [{
"tenant_id": "my56a9c966df069",
"tenant_code": "mysoft_ci",
"tenant_name": "测试企业",
"scrm_customer_id": "92c15ba6-c472-4b22-bcd6-5d7930d6e61b",
"scrm_top_customer_id": "92c15ba6-c472-4b22-bcd6-5d7930d6e61b",
"scrm_authorize_guid": "92c15ba6-c472-4b22-bcd6-5d7930d6e61b",
"erpapi_url":"http://ci.mysoft.com.cn:8081/fdccloud_307"
}]
}
参数说明:
参数名称 | 说明 |
---|---|
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) |
请求包结构
{
"owner_area":"8",
"contract_number":"LY0020191008000016",
"contract_name":"中铁房地产集团(福州)有限公司",
"tenant_code":"zhongtie_ci",
"customer_id":"28af4f13-45d2-4443-8efb-006e7fdbd585",
"customer_name":"中铁房地产集团(福州)有限公司",
"admin_name":"张三",
"admin_mail":"zhangs01@mingyuanyun.com",
"admin_phone":"13657250918",
"yzs_expire_at":"2021-09-18",
"from":"erp_manager"
}
请求参数说明
参数 | 是否必须 | 描述 |
---|---|---|
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 | 否 | 开租户比较耗时,租户接口会以回调方式通知调用方 |
返回结果
{
"success": 1,
"data": {
"tenant_id": "my611a29d4053cd",
"tenant_code": "zxl_test_3"
}
}
参数 | 类型 | 描述 |
---|---|---|
code | number | 当前接口逻辑结果1-成功;非1-错误 |
message | string | 提示信息 |
success | number | 服务端框架层结果 1:成功 0:失败,对应的data为错误信息字符串 |
tenant_id | string | 租户id |
tenant_code | string | 租户code |
callback_url回调样例代码
$data = [
'tenant_code'=>$tenant_code,
'success'=>$isOk,
'message'=>$err
];
$curl = new Curl();
//post formdata方式
$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
{
"from": "jmpt",
"tenant_code": "ywy_ci"
}
参数说明:
参数名称 | 必须 | 说明 |
---|---|---|
from | 是 | 初始化来源,jmpt:建模平台 |
tenant_code | 是 | 企业代码 |
返回值
{
"errcode": 0,
"errmsg": "ok"
}
参数说明:
参数名称 | 说明 |
---|---|
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
{
"tenant_id": "my56a9c966df069",
"app_name": "移动审批",
"app_memo": "随时随地,轻松审批",
"app_logo_url": "https://x/images/mWorkflow_640_v3.png",
"openurl": "http://x/index?kindType=5",
"backend_url": "http://x/settings/basic/index",
"enable_visual_range_ctrl":1,
"enable_auth_ctrl":1,
"owner":"张三"
}
参数说明:
参数名称 | 必须 | 说明 |
---|---|---|
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应用发布后,需要云助手团队审核通过,客户才能在云助手中看到对应的应用
返回值
{
"errcode": 0,
"errmsg": "ok",
"data": {
"app_code": "9001",
"app_key": "third5810502b5e148"
}
}
参数说明:
参数名称 | 说明 |
---|---|
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
{
"app_key": "third5810502b5e148",
"tenant_id": "my56a9c966df069",
"app_name": "移动审批",
"app_memo": "随时随地,轻松审批",
"app_logo_url": "https://x/images/mWorkflow_640_v3.png",
"openurl": "http://x/index?kindType=5",
"backend_url": "http://x/settings/basic/index",
"enable_visual_range_ctrl":1,
"enable_auth_ctrl":1,
"app_type":2,
"download_url":"https://a.b.c/d.zip",
"owner":"张三"
}
参数说明:
参数名称 | 必须 | 说明 |
---|---|---|
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应用更新后,需要云助手团队审核通过,客户才能在云助手中看到更新后的应用
返回值
{
"errcode": 0,
"errmsg": "ok",
"data": {
"app_code": "9001",
"app_key": "third5810502b5e148"
}
}
参数说明:
参数名称 | 说明 |
---|---|
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) |
请求包结构
{
"add_authorized_appkey":"mysoft5d36b507746b1,mysoft6116305e0b16d",
"del_authorized_appkey":"mysoft61161a7750d79",
"tenant_id": "my56a9c966df069"
}
请求参数说明
参数 | 是否必须 | 描述 |
---|---|---|
access_token | 是 | pt_token(平台token) |
tenant_id | 是 | 租户id |
add_authorized_appkey | 否 | 需要进行授权的应用key,同时授权多个用,隔开 |
del_authorized_appkey | 否 | 取消授权的应用key,同时取消授权多个用,隔开 |
返回结果
{
"success": 1,
"data": "应用授权成功"
}
参数 | 类型 | 描述 |
---|---|---|
success | number | 当前接口逻辑结果1-成功;非1-失败 |
data | string | 提示信息 |