\n\n\n Toolchain landing page sdk用于帮助用户基于 标准landingpage 的二次开发. 该sdk封装了从toolchain\n 获取数据的整个过程, 用户可基于该sdk 快速搭建自己的展示页\n
\n
| Code | \nMessage | \n
|---|---|
| 1 | \nsuccess | \n
| 0 | \n\n response error \n \n case 1. Vid parameter error \n \n case 2. Page did not public and inaccessible \n \n case 3. VID did not query data \n \n case 4. Query UUID does not exist \n \n case 5. Unable to read product information\n | \n
| -1 | \nserverError | \n
npm install toolchain-landingpage-web-sdk var vlSDK = require('toolchain-landingpage-web-sdk')\n // Or es6\n import vlSDK from 'toolchain-landingpage-web-sdk'\n // You can copy directory dist/vlSDK.js or vlSDK.min.js to your projectcd examples/landingpage\nnpm install\nnpm run dev\nopen http://localhost:8080/index.html?vid=0xA9D641151E519C33BA9D7A85CF5970AF790164412C51F6270329CC1A77EC1B02\n\n获取指定vid的DCP模型的uuids和key。
\n
\n 请求参数:\n
\n| 名称 | \n类型 | \n默认值 | \n必填 | \n描述 | \n
|---|---|---|---|---|
| params | \nObject | \nN/A | \ntrue | \n\n |
| params.vid | \nString | \nN/A | \ntrue | \nvid | \n
| success | \nFunction | \nN/A | \nfalse | \nsuccess function | \n
| fail | \nFunction | \nN/A | \nfalse | \nfail function | \n
| callback | \nFunction | \nN/A | \nfalse | \ncallback function | \n
\n 请求示例:\n
\nvlSDK.getUuids({\n params:{\n vid: '0xA9D641151E519C33BA9D7A85CF5970AF790164412C51F6270329CC1A77EC1B02'\n },\n success: function(res){\n // success here\n console.log('success', res)\n },\n fail: function(err) {\n // error here\n console.log('error', err)\n },\n callback: function(res){\n // callback\n console.log('callback', res)\n }\n })\n 返回示例:\n
\n{\n \"code\": \"common.success\",\n \"data\": {\n \"modelUuidList\": [\n {\n \"modelName\": \"创建SKU\",\n \"modelUuid\": \"00000000-af64-4f04-b94f-745900200000\",\n \"key\": \"sku\"\n },\n {\n \"modelUuid\": \"00000000-0dcc-419a-89f5-618700200012\",\n \"key\": \"buinfo\"\n },\n {\n \"modelName\": \"自定义展示信息\",\n \"modelUuid\": \"00000000-312c-452d-bf65-e7cd00200006\",\n \"key\": \"customizedDisplayInfo\"\n },\n {\n \"modelName\": \"追溯信息\",\n \"modelUuid\": \"00000000-2f39-4d87-a45a-9aa100200005\",\n \"key\": \"trackinfo\"\n }\n ]\n }\n}\n\n使用Promise获取VID数据。
\n
\n 请求参数:\n
\n| 名称 | \n类型 | \n默认值 | \n必填 | \n描述 | \n
|---|---|---|---|---|
| params | \nObject | \nN/A | \ntrue | \n\n |
| params.vid | \nString | \nN/A | \nfalse | \nvid 如果没传, sdk会从window.location里面取 | \n
| params.types | \nArray | \nN/A | \ntrue | \nDCP 信息, 可以通过接口 vlSDK.getUuids获得。 | \n
| params.language | \nString | \nN/A | \nfalse | \n设定请求的返回语言(参考: 系统语言与浏览器语言对照表), 未指定语言, sdk 会从浏览器中获取. | \n
| params.service | \nString | \nN/A | \nfalse | \n当SDK开发的landingpage 用于vechain toolchain平台内部预览时,需传入 项目环境. 阿里传人ali, 亚马逊传入aws. 该参数没传时如果页面的host是 *.vetoolchain.com 则会判断为aws, 否则为ali. \n*.vetoolchain.com 为vechain toolchain平台aws项目上传landingpage包后自动分配的域名.开发者如果不是自己部署的landingpage 域名, 可以不传该参数. 针对独立部署的域名, 内部预览时需要关注该参数\n | \n
\n 请求示例:\n
\n vlSDK.fetch({\n vid: '0xA9D641151E519C33BA9D7A85CF5970AF790164412C51F6270329CC1A77EC1B02'\n types: ['sku', 'buinfo', 'customizedDisplayInfo', 'trackinfo']\n }).then(function(res){\n console.log(res)\n }).catch(function(res){\n console.log(res)\n })\n 响应示例:\n
\n{\n \"vid\": \"0XA9D641151E519C33BA9D7A85CF5970AF790164412C51F6270329CC1A77EC1B02\",\n \"displayType\": \"all\",\n \"chain\": \"mainnet\",\n \"jsonData\": {\n \"customizedDisplayInfo\": {\n \"blockinfo\": {\n \"dataUuid\": \"00000000-b71b-4603-bb7d-34bf02200006\",\n \"hash\": \"0x49c83e104f737d85779ac978a93370c8b92821d0a936527666cefec07709f853\"\n },\n \"custom\": {\n \"morevideos\": [],\n \"webpages\": [\n {\n \"webpagelink\": \"123213\",\n \"webpagename\": \"13123\"\n }\n ],\n \"loadingvideo\": {},\n \"moreimages\": []\n },\n \"base\": {\n \"name\": \"活动信息\",\n \"timestamp\": 1585222980873\n }\n },\n \"trackinfo\": [\n {\n \"blockinfo\": {\n \"clauseIndex\": 0,\n \"uid\": \"0xee4a598fbf10b0dfba132311fb364dca773505f4c8bffae335b76a4cbeb8d5a0\",\n \"chain\": \"FORMAL\",\n \"dataVid\": \"0xb933277a001585222751adfe0777b8f9711e01d95bace5fef315c1f2728f621d\",\n \"dataUuid\": \"00000000-0a9b-4d3f-b9c1-326902200005\",\n \"contract\": \"73ee38b2e5944ac2b88e923d40f31b42\",\n \"txId\": \"0xb7f786e4b24bbd6b54624a10b94b3883b5c68f164b37de912afeeb624fa1eefc\",\n \"hash\": \"0x10534bc7190c5d2da9c722c2a11955bf5b34dee2dd57d7185c1fd4d1c1b1866a\",\n \"memberId\": \"18011\"\n },\n \"custom\": {\n \"tracktime\": 1585222661494,\n \"gps\": {\n \"country\": \"中国\",\n \"address\": \"\",\n \"province\": \"上海\",\n \"city\": \"上海\",\n \"street\": \"\",\n \"precision\": \"65.0\",\n \"district\": \"\",\n \"lon\": \"121.476753\",\n \"lat\": \"31.224349\"\n },\n \"department\": \"123123\",\n \"vidlist\": {\n \"type\": 0,\n \"vidlist\": [\n \"0xa9d641151e519c33ba9d7a85cf5970af790164412c51f6270329cc1a77ec1b02\"\n ]\n }\n },\n \"base\": {\n \"name\": \"追溯001\",\n \"timestamp\": 1585222801163\n }\n }\n ],\n \"sku\": {\n \"blockinfo\": {\n \"clauseIndex\": 0,\n \"uid\": \"0xee4a598fbf10b0dfba132311fb364dca773505f4c8bffae335b76a4cbeb8d5a0\",\n \"chain\": \"FORMAL\",\n \"dataVid\": \"0xb933277a0015852227513ddd792a58115d47e9d230944eec5013ed5eb8e71f86\",\n \"dataUuid\": \"00000000-e746-401d-855f-52f402200000\",\n \"contract\": \"73ee38b2e5944ac2b88e923d40f31b42\",\n \"txId\": \"0x7d8ad1531387ae0a43c9cda23e035e0b8e2956ab5669468bfa8db590c00b8321\",\n \"hash\": \"0x2234e207acc6eb2f00599f525cd8150adce0541bcf40713112eb6b03364f8cf3\",\n \"memberId\": \"18011\"\n },\n \"base\": {\n \"mainimage\": {\n \"filelocation\": \"https://datacenter.vetoolchain.com/v1/data/619e5e4e8ab7e5379fb4d374d75534ef/fd9b04031d013158c887736f077907e227667237260bd1d0c4bbd4c17279f994?token=0a274bd5-bf88-4f9c-8cf5-56a7036c543b\",\n \"filetype\": \"jpeg\",\n \"filename\": \"不二家.jpeg\",\n \"filesize\": 125737,\n \"filehash\": \"fd9b04031d013158c887736f077907e227667237260bd1d0c4bbd4c17279f994\"\n },\n \"skucode\": \"sku---1\",\n \"productname\": \"sku---1\",\n \"description\": \"\",\n \"files\": [],\n \"productparames\": [],\n \"timestamp\": 1585222741132\n }\n },\n \"buinfo\": {\n \"blockinfo\": {\n \"dataUuid\": \"00000000-b09a-4b4d-9940-65bf02200012\",\n \"hash\": \"0xf0e72145fcbb609d7180689bbf13932719ecb99d22439f07aa9a2678054aaa12\"\n },\n \"custom\": {\n \"encity\": \"we we we\",\n \"encountry\": \"中国\",\n \"enstreet\": \"e we we w\",\n \"mainwebpage\": {\n \"webpagelink\": \"4\",\n \"webpagename\": \"3\"\n },\n \"emaillist\": [\n {\n \"emailname\": \"2\",\n \"emailaddress\": \"1\"\n }\n ],\n \"enprovince\": \"we e w we\",\n \"endistrict\": \"e w w e e w\"\n },\n \"base\": {\n \"enlogo\": {\n \"filelocation\": \"https://datacenter.vetoolchain.com/v1/data/619e5e4e8ab7e5379fb4d374d75534ef/4ae408ceda47a5ea261adb95ab74488e1573dc179f102055c8acc940de19a9cd?token=8bdf10f8-d8b4-4e2a-a0f5-e56b9ab428a3\",\n \"filetype\": \"jpg\",\n \"filename\": \"u=726395026,155417430&fm=11&gp=0.jpg\",\n \"filesize\": 10359,\n \"filehash\": \"4ae408ceda47a5ea261adb95ab74488e1573dc179f102055c8acc940de19a9cd\"\n },\n \"enname\": \"测试公司\",\n \"timestamp\": 1583914710732\n }\n }\n },\n \"certUrl\": \"https://cert-v4.vetoolchain.com/?vid=0XA9D641151E519C33BA9D7A85CF5970AF790164412C51F6270329CC1A77EC1B02\",\n \"explorerUrl\": \"https://explore.vechain.org\",\n \"advert\": \"pro\"\n}\n 系统语言与浏览器语言对照表\n
\n| 语言 | \n系统语言 | \n浏览器语言 | \n备注 | \n
|---|---|---|---|
| English | \nen | \nen/en-(*) | \n\n \n en/en-(*)表示浏览器语言为 中的任意一种浏览器语言。 \n | \n
| 中文简体 | \nzh-CN | \nzh-cn/zh | \n浏览器语言为zh-cn或者zh | \n
| 中文繁体 | \nzh-HK | \nzh-hk/zh-tw | \n浏览器语言为zh-hk或者zh-tw | \n
| Deutsch | \nde | \nde/de-(*) | \n参考en的备注 | \n
| 日本語 | \nja | \nja | \n\n |
| 한국어 | \nko | \nko | \n\n |
| Bahasa Melayu | \nms | \nms | \n\n |
| italiano | \nit-CH | \nit/it-(*) | \n参考en的备注 | \n
| français | \nfr-CH | \nfr/fr-(*) | \n参考en的备注 | \n
| Türkçe | \ntr | \ntr | \n\n |
| Русский | \nru | \nru/ru-(*) | \n参考en的备注 | \n
| ไทย | \nth | \nth | \n\n |
| العربية | \nar | \nar | \n\n |
| עברית | \nhe | \nhe | \n\n |
| Bahasa Indonesia | \nid | \nid | \n\n |
| Português | \npt-br | \npt/pt-(*) | \n参考en的备注 | \n
| Tiếng Việt | \nvi | \nvi | \n\n |
| Español | \nes | \nes/es-(*) | \n参考en的备注 | \n
\n\n使用回调获取vid数据。
\n
\n 请求参数:\n
\n| 名称 | \n类型 | \n默认值 | \n必填 | \n描述 | \n
|---|---|---|---|---|
| params | \nObject | \nN/A | \ntrue | \n\n |
| params.vid | \nString | \nN/A | \nfalse | \nvid 如果没传, sdk会从window.location里面取 | \n
| params.types | \nArray | \nN/A | \ntrue | \nDCP 信息, 可以通过接口 vlSDK.getUuids获得。 | \n
| params.language | \nString | \nN/A | \nfalse | \n设定请求的返回语言(参考: 系统语言与浏览器语言对照表), 未指定语言, sdk 会从浏览器中获取. | \n
| params.service | \nString | \nN/A | \nfalse | \n当SDK开发的landingpage 用于vechain toolchain平台内部预览时,需传入 项目环境. 阿里传人ali, 亚马逊传入aws. 该参数没传时如果页面的host是 *.vetoolchain.com 则会判断为aws, 否则为ali. \n*.vetoolchain.com 为vechain toolchain平台aws项目上传landingpage包后自动分配的域名.开发者如果不是自己部署的landingpage 域名, 可以不传该参数. 针对独立部署的域名, 内部预览时需要关注该参数 | \n
| success | \nFunction | \nNone | \nfalse | \nsuccess function | \n
| fail | \nFunction | \nNone | \nfalse | \nfail function | \n
| callback | \nFunction | \nNone | \nfalse | \ncallback function | \n
\n 请求示例:\n
\nvlSDK({\n params: {\n vid: '0xA9D641151E519C33BA9D7A85CF5970AF790164412C51F6270329CC1A77EC1B02'\n types: ['sku', 'buinfo', 'customizedDisplayInfo', 'trackinfo'] \n },\n // success\n success: function(res){\n console.log(res)\n },\n // fail\n fail: function(res){\n console.log(res)\n },\n // callback\n callback: function(res){\n\n }\n }) \n 响应示例:\n
\n{\n \"vid\": \"0XA9D641151E519C33BA9D7A85CF5970AF790164412C51F6270329CC1A77EC1B02\",\n \"displayType\": \"all\",\n \"chain\": \"mainnet\",\n \"jsonData\": {\n \"customizedDisplayInfo\": {\n \"blockinfo\": {\n \"dataUuid\": \"00000000-b71b-4603-bb7d-34bf02200006\",\n \"hash\": \"0x49c83e104f737d85779ac978a93370c8b92821d0a936527666cefec07709f853\"\n },\n \"custom\": {\n \"morevideos\": [],\n \"webpages\": [\n {\n \"webpagelink\": \"123213\",\n \"webpagename\": \"13123\"\n }\n ],\n \"loadingvideo\": {},\n \"moreimages\": []\n },\n \"base\": {\n \"name\": \"活动信息\",\n \"timestamp\": 1585222980873\n }\n },\n \"trackinfo\": [\n {\n \"blockinfo\": {\n \"clauseIndex\": 0,\n \"uid\": \"0xee4a598fbf10b0dfba132311fb364dca773505f4c8bffae335b76a4cbeb8d5a0\",\n \"chain\": \"FORMAL\",\n \"dataVid\": \"0xb933277a001585222751adfe0777b8f9711e01d95bace5fef315c1f2728f621d\",\n \"dataUuid\": \"00000000-0a9b-4d3f-b9c1-326902200005\",\n \"contract\": \"73ee38b2e5944ac2b88e923d40f31b42\",\n \"txId\": \"0xb7f786e4b24bbd6b54624a10b94b3883b5c68f164b37de912afeeb624fa1eefc\",\n \"hash\": \"0x10534bc7190c5d2da9c722c2a11955bf5b34dee2dd57d7185c1fd4d1c1b1866a\",\n \"memberId\": \"18011\"\n },\n \"custom\": {\n \"tracktime\": 1585222661494,\n \"gps\": {\n \"country\": \"中国\",\n \"address\": \"\",\n \"province\": \"上海\",\n \"city\": \"上海\",\n \"street\": \"\",\n \"precision\": \"65.0\",\n \"district\": \"\",\n \"lon\": \"121.476753\",\n \"lat\": \"31.224349\"\n },\n \"department\": \"123123\",\n \"vidlist\": {\n \"type\": 0,\n \"vidlist\": [\n \"0xa9d641151e519c33ba9d7a85cf5970af790164412c51f6270329cc1a77ec1b02\"\n ]\n }\n },\n \"base\": {\n \"name\": \"追溯001\",\n \"timestamp\": 1585222801163\n }\n }\n ],\n \"sku\": {\n \"blockinfo\": {\n \"clauseIndex\": 0,\n \"uid\": \"0xee4a598fbf10b0dfba132311fb364dca773505f4c8bffae335b76a4cbeb8d5a0\",\n \"chain\": \"FORMAL\",\n \"dataVid\": \"0xb933277a0015852227513ddd792a58115d47e9d230944eec5013ed5eb8e71f86\",\n \"dataUuid\": \"00000000-e746-401d-855f-52f402200000\",\n \"contract\": \"73ee38b2e5944ac2b88e923d40f31b42\",\n \"txId\": \"0x7d8ad1531387ae0a43c9cda23e035e0b8e2956ab5669468bfa8db590c00b8321\",\n \"hash\": \"0x2234e207acc6eb2f00599f525cd8150adce0541bcf40713112eb6b03364f8cf3\",\n \"memberId\": \"18011\"\n },\n \"base\": {\n \"mainimage\": {\n \"filelocation\": \"https://datacenter.vetoolchain.com/v1/data/619e5e4e8ab7e5379fb4d374d75534ef/fd9b04031d013158c887736f077907e227667237260bd1d0c4bbd4c17279f994?token=0a274bd5-bf88-4f9c-8cf5-56a7036c543b\",\n \"filetype\": \"jpeg\",\n \"filename\": \"不二家.jpeg\",\n \"filesize\": 125737,\n \"filehash\": \"fd9b04031d013158c887736f077907e227667237260bd1d0c4bbd4c17279f994\"\n },\n \"skucode\": \"sku---1\",\n \"productname\": \"sku---1\",\n \"description\": \"\",\n \"files\": [],\n \"productparames\": [],\n \"timestamp\": 1585222741132\n }\n },\n \"buinfo\": {\n \"blockinfo\": {\n \"dataUuid\": \"00000000-b09a-4b4d-9940-65bf02200012\",\n \"hash\": \"0xf0e72145fcbb609d7180689bbf13932719ecb99d22439f07aa9a2678054aaa12\"\n },\n \"custom\": {\n \"encity\": \"we we we\",\n \"encountry\": \"中国\",\n \"enstreet\": \"e we we w\",\n \"mainwebpage\": {\n \"webpagelink\": \"4\",\n \"webpagename\": \"3\"\n },\n \"emaillist\": [\n {\n \"emailname\": \"2\",\n \"emailaddress\": \"1\"\n }\n ],\n \"enprovince\": \"we e w we\",\n \"endistrict\": \"e w w e e w\"\n },\n \"base\": {\n \"enlogo\": {\n \"filelocation\": \"https://datacenter.vetoolchain.com/v1/data/619e5e4e8ab7e5379fb4d374d75534ef/4ae408ceda47a5ea261adb95ab74488e1573dc179f102055c8acc940de19a9cd?token=8bdf10f8-d8b4-4e2a-a0f5-e56b9ab428a3\",\n \"filetype\": \"jpg\",\n \"filename\": \"u=726395026,155417430&fm=11&gp=0.jpg\",\n \"filesize\": 10359,\n \"filehash\": \"4ae408ceda47a5ea261adb95ab74488e1573dc179f102055c8acc940de19a9cd\"\n },\n \"enname\": \"测试公司\",\n \"timestamp\": 1583914710732\n }\n }\n },\n \"certUrl\": \"https://cert-v4.vetoolchain.com/?vid=0XA9D641151E519C33BA9D7A85CF5970AF790164412C51F6270329CC1A77EC1B02\",\n \"explorerUrl\": \"https://explore.vechain.org\",\n \"advert\": \"pro\"\n}