跳到主要内容

SDK 概述与安装

SDK 供云应用代码调用平台能力；发布、回滚、日志和数据库代理仍由 xdbapp CLI 完成。

什么时候需要 SDK​

需要以下任一能力时安装 SDK：

  • 获取当前访问者的信多帮登录身份；
  • 从服务端调用信多帮开放平台；
  • 上传和读取应用文件；
  • 在 Production 后端投递、查询和取消一次性延迟任务；
  • 读取 App、Deployment、Preview/Production 和数据库绑定。

普通静态展示页如果不使用这些能力，可以不安装。

当前正式版为 0.2.0，新增 订阅事件验签与回执。已包含本地联调、延迟任务、版本素材、订单与营员专用方法及 V2 签名，并兼容先建订单后补营员。见延迟任务调用说明和调用开放平台。

SDK 使用下方官方固定版本下载地址，不需要私有 npm/PyPI 源或访问令牌。不要只凭包名在公共 Registry 中安装；查不到包不代表需要客户提供私有源，也不要为此创建或改写 .npmrc、猜测 ^1.0.0 等版本。AI 应按项目语言自行安装；下载失败先检查官方地址的 HTTP 状态和网络连接，再说明实际错误。已有项目的自定义依赖配置保持不变。

JavaScript / Node.js​

当前官方正式发布包：

npm install https://paas.xinduobang.cn/sdk/releases/0.2.0/xdb-paas-sdk-javascript-0.2.0.tgz

浏览器代码：

import { xdbPaaS } from "@xinduobang/xdb-paas-sdk/browser";

Node.js 服务端代码：

import { xdbPaaS } from "@xinduobang/xdb-paas-sdk/server";

Python​

python -m pip install https://paas.xinduobang.cn/sdk/releases/0.2.0/xdb_paas_sdk-0.2.0-py3-none-any.whl
from xdb_paas import xdb_paas
固定版本

把完整版本 URL 写入 package.json、锁文件或 requirements.txt，让旧应用不会因 SDK 发布新版本而自动改变。升级时再由本地 AI 或开发者明确修改版本。

只安装一套​

Node.js 项目安装 JavaScript SDK，Python 项目安装 Python SDK；不要在同一个后端项目里同时安装两套。

旧项目不会自动升级 SDK。建议统一更新到正式版 0.2.0，更新锁文件或 requirements.txt，再运行项目自己的测试并重新发布预览。原来的通用 request() 保持兼容；新订单与营员专用方法需按调用示例接入。