@geovis/datacloud-channel-sdk

datacloud-sdk-demo-nodejs

• 本文档用于指导开发者对接数据云个人用户

主要流程 [参考]

第一步、前往 https://datacloud.geovisearth.com 注册datacloud开发者账号。

第二步、提供注册账号信息，联系管理员申请接入需要的 secretId,secretKey和对接的channelId信息

第三步、安装sdk, 使用secretId,secretKey和channelId信息初始化SDK

# npm
npm install @geovis/datacloud-channel-sdk --save
# yarn
yarn add @geovis/datacloud-channel-sdk

const DatacloudChannelSdk = require("@geovis/datacloud-channel-sdk");

const instance = new DatacloudChannelSdk(
    '<your secretId>',
    '<your secretKey>',
    '<your channelId>',
);

// 通过手机号授权并获取访问Token
instance.getTokenByPhone('19912345678').then(r => {
    console.log(JSON.stringify(r, null, 4))
})

// public应用列表
instance.getApplicationList('19912345678').then(r => {
    console.log(JSON.stringify(r, null, 4))
})

// 刷新应用的token
instance.refreshToken('19912345678', 'YZJQ4ggozLp0Mhuy').then(r => {
    console.log(JSON.stringify(r, null, 4))
})

// 获取用量
instance.getUsage('YZJQ4ggozLp0Mhuy').then(r => {
    console.log(JSON.stringify(r, null, 4))
})

API文档

1、通过手机号授权并获取访问Token

方法签名: async getTokenByPhone(phone)

参数:

参数名	类型	必填	说明
phone	string	是	手机号

返回值示例:

{
  "code": 0,
  "data": {
    "createdTime": 1704178611366,
    "updatedTime": 1704247314699,
    "appId": "YZJQ4ggozLp0Mhuy",
    "appName": "测试-专属应用",
    "developerId": "tthCkFxezhrMQT9O2sHhzDm7y-boiN6C",
    "status": "normal",
    "secrecy": "public",
    "token": "8ba29bb3527ddf2970e0c27f9009a1ade64fdc25e79be378ce32096de5765910",
    "referers": "",
    "emptyReferer": false,
    "startTime": 1704247314708,
    "expireTime": 2400000,
    "ssoChannel": "f418a7a8-ed69-4b73-b395-bdddf64d9384"
  }
}

2、获取public应用列表

方法签名: getApplicationList(phone)

参数:

参数名	类型	必填	说明
phone	string	是	手机号

返回值示例:

{
  "code": 0,
  "data": [
    {
      "createdTime": 1704178611366,
      "updatedTime": 1704189839469,
      "appId": "YZJQ4ggozLp0Mhuy",
      "appName": "测试-专属应用",
      "developerId": "tthCkFxezhrMQT9O2sHhzDm7y-boiN6C",
      "status": "normal",
      "secrecy": "public",
      "token": "9cacf8638471b74221616545c765c1f1727338f14aa627c47bc1fdcc40f6fb09",
      "referers": "",
      "emptyReferer": false,
      "startTime": 1704189839467,
      "expireTime": 2400000,
      "ssoChannel": "f418a7a8-ed69-4b73-b395-bdddf64d9384"
    }
  ]
}

3、刷新应用的token

方法签名: async refreshToken(phone, appId)

参数:

参数名	类型	必填	说明
phone	string	是	手机号
appId	string	是	应用id

返回值示例:

{
  "code": 0,
  "data": {
    "createdTime": 1704178611366,
    "updatedTime": 1704247314699,
    "appId": "YZJQ4ggozLp0Mhuy",
    "appName": "测试-专属应用",
    "developerId": "tthCkFxezhrMQT9O2sHhzDm7y-boiN6C",
    "status": "normal",
    "secrecy": "public",
    "referers": "",
    "emptyReferer": false,
    "startTime": 1704247314708,
    "expireTime": 2400000,
    "ssoChannel": "f418a7a8-ed69-4b73-b395-bdddf64d9384",
    "tokens": [
      {
        "createTime": "2024-01-03T02:01:54.708Z",
        "updateTime": "2024-01-03T02:01:54.708Z",
        "token": "8ba29bb3527ddf2970e0c27f9009a1ade64fdc25e79be378ce32096de5765910",
        "status": "normal",
        "flag": null,
        "description": null
      },
      {
        "createTime": "2024-01-02T10:03:59.467Z",
        "updateTime": "2024-01-03T02:01:54.705Z",
        "token": "9cacf8638471b74221616545c765c1f1727338f14aa627c47bc1fdcc40f6fb09",
        "status": "disabled",
        "flag": null,
        "description": null
      }
    ]
  }
}

4、获取用量

方法签名: async getUsage(appId)

参数:

参数名	类型	必填	说明
appId	string	是	应用id

返回值示例:

{
  "code": 0,
  "data": {
    "id": "znu5oZQXfsjGvVIoSTArDhMu1_yIXwco",
    "createTime": "2023-12-28T07:38:13.062Z",
    "updateTime": "2023-12-28T07:38:13.062Z",
    "deleteTime": null,
    "developerId": "tthCkFxezhrMQT9O2sHhzDm7y-boiN6C",
    "type": 1,
    "trafficSpecify": "self",
    "status": "normal",
    "trafficLevel": "quota/gu/gu1",
    "trafficStartTime": 1703749093082,
    "trafficExpiretime": -1,
    "emptyReferer": false,
    "referers": null,
    "dataPack": {
      "name": "政企免费版",
      "traffic": {
        "interval": 86400,
        "quota": 50000
      },
      "currentUsage": 0
    }
  }
}