数维图API文档:SovitJS编辑器API调用说明

SovitChart、Sovit2D、Sovit3D已经在众多行业领域被使用,也受到了大家的一致好评,为了更好的二次开发,不少用户想把我们的编辑器集成在自己的系统中,强烈要求我们开放API接口,经过技术团队的努力,大家千呼万唤的API,它终于来了!

为了让大家更快的熟悉数维图SovitJS编辑器API,为此整理了一份详细的教程。

#1、数维图API能做什么?

有人可能会问,API是什么?数维图API又能做什么?为什么这么多开发者迫不及待要调用数维图API?

简单的说,通过调用API,可以将我们的2D、3D和大屏编辑器无缝集成到你的业务系统/产品中,实现无代码开发二维、三维可视化场景。

通过API,可以在自己的系统中获取产品项目、场景相关数据,与自己的业务数据进行关联,实现在业务系统中对场景的管理与快速编辑。

集成数维图拖拽式编辑器后的业务系统/产品,具有更强的市场上竞争力,对客户来说更具吸引力。

#2、数维图API怎么调用?

调用开放API接入编辑器前,必须进行通过签名认证的方式获取会话token。

# 签名认证方法 #

不管是云端还是私有部署版,登录系统后都可以看到一个“开发者信息”,包含“开发者Apikey”和“开发者Secret”,通过这两个信息生成签名信息。

Apikey和Secret生成签名规则:

Apikey+Secret(密钥)+Timestamp(时间戳)组成的字符串MD5加密码生成。

注意:为安全起见,签名代码应由后端程序生成,Secret不要暴露在前端代码中。Access_token获取成功后建议存储在SessionStorage中,以便调用接口时使用。

# 获取Token方法 #

获取Token:云端版获取方法

返回数据

{

"code": 200.//返回代码200为成功

"msg": "OK",//返回消息

"datas": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"//返回token的值

}

获取Token:私有部署版获取方法

API请求址:http://localhost:9188/Rest/sso/free/getToken

请求method:POST

参考请求方法如下:

$.ajax({

url: "http://localhost:9188/Rest/sso/free/getToken",

method: 'POST',

contentType: "application/json;charset=UTF-8",

data: JSON.stringify({

apikey: '3148080387327000581',

timestamp: '1234567890',

signature: '311f32ce3c9938006d296a844c3bc8d1',

userName: 'zhangs'

}),

success: function(data) {

if(data.code=='200') {

access_token = data.datas;

sessionStorage.setItem("access_token",access_token);

}else{

$("#re_datas").html(data.msg);

}

},

error: function(msg) {

console.info(msg);

$("#re_datas").html(JSON.stringify(msg))

}

})

# SSO登录 #

对于私有部署版,在使用签名获取token会话的同时可以进行帐号登录(注:私有部署版产品本身有自己的一套用户管理系统),第三方系统可以通过此方法将系统中的帐号同步到SovitJS私有部署版中。

#3、数维图编辑器怎么接入?

编辑器通过iframe接入到自己的系统中。

Sovit2D编辑器接入参考

私有版接入地址:

pageId:要编辑的场景的id

access_token:会话token

http://localhost:9188/#/sovit2dEmbed?pageId=xxx&access_token=xxx

云端版接入地址:

https://admin.sovitjs.com/sovit2dEmbed?pageId=xxx&access_token=xxx

<iframe id="editFrame" src="" width="100%" height="850" frameBorder="0" border="none"></iframe>

<script>

let access_token = "";//token获取获取请参考上一篇

$(document).ready(function() {

let bodyHeight = document.documentElement.clientHeight - 83;

$("#editFrame").css("height",bodyHeight);

access_token = sessionStorage.getItem("access_token");

if(access_token!=null) {

$("#editFrame").attr("src","http://localhost:9188/#/sovit2dEmbed?pageId=3046607006338121987&access_token="+access_token);

}else{

alert("token不存在,请先获取token");

}

</script>

Sovit3D编辑器接入参考

私有版接入地址:

pageId:要编辑的场景的id

access_token:会话token

http://localhost:9188/#/sovit3dEmbed?pageId=xxx&access_token=xxx

云端版接入地址:

https://admin.sovitjs.com/sovit3dEmbed?pageId=xxx&access_token=xxx

<iframe id="editFrame" src="" width="100%" height="850" frameBorder="0" border="none"></iframe>

<script>

let access_token = "";//token获取获取请参考上一篇

$(document).ready(function() {

let bodyHeight = document.documentElement.clientHeight - 83;

$("#editFrame").css("height",bodyHeight);

access_token = sessionStorage.getItem("access_token");

if(access_token!=null) {

$("#editFrame").attr("src","http://localhost:9188/#/sovit3dEmbed?pageId=30466070012121212121&access_token="+access_token);

}else{

alert("token不存在,请先获取token");

}

</script>

SovitChart编辑器接入参考

私有版接入地址:

pageId:要编辑的场景的id

access_token:会话token

http://localhost:9188/#/sovitchartEmbed?pageId=xxx&access_token=xxx

云端版接入地址:

https://admin.sovitjs.com/sovitchartEmbed?pageId=xxx&access_token=xxx

<iframe id="editFrame" src="" width="100%" height="850" frameBorder="0" border="none"></iframe>

<script>

let access_token = "";//token获取获取请参考上一篇

$(document).ready(function() {

let bodyHeight = document.documentElement.clientHeight - 83;

$("#editFrame").css("height",bodyHeight);

access_token = sessionStorage.getItem("access_token");

if(access_token!=null) {

$("#editFrame").attr("src","http://localhost:9188/#/sovit3dEmbed?pageId=30466070012121212121&access_token="+access_token);

}else{

alert("token不存在,请先获取token");

}

</script>

注意:localhost:9188需替换为私有部署版的访问地址和端口

看到这,是不是已经迫不及待想要体验一下了?

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,591评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,448评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,823评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,204评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,228评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,190评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,078评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,923评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,334评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,550评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,727评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,428评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,022评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,672评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,826评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,734评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,619评论 2 354

推荐阅读更多精彩内容