@ asiyst/ sdk
客户端运行时间将一个网站连接到Asiyst Cloud.
此软件包不包含模型密钥,数据库证书,也不包含其他服务器机密. 以 projectId 财务报告和审定财务报表 publicKey 只有这个 这些价值是公共项目证书,而不是秘密.
安装
npm install @asiyst/sdk
然后连接工程 :
npx @asiyst/cli init
asiyst init 打开 https://sayst.com (中文(简体) ) 这样您就可以创建一个项目并复制证书。 神通外观和行为都住在Asiyst Cloud,这样你就可以在不重新部署网站的情况下改变它们.
使用量
需要项目ID。 该值必须是目标Asiyst项目的公共项目ID,而不是开发商账户用户ID,而不是内部Supabase UUID.
import { Asiyst } from "@asiyst/sdk";
await Asiyst.init({
projectId: "<PUBLIC_PROJECT_ID>",
publicKey: "<PUBLIC_KEY>",
avatarId: "<PUBLIC_AVATAR_ID>",
});
Asiyst.open();
不传递密钥为 API publicKey 或省略 projectId。 。 。 .
avatarId 是一个公开的标识,而不是授权证书。 服务器仍然对项目和安装授权具有权威性.
知识源,包括可选的GitHub寄存器,在Asiyst Web中配置. SDK不接受GitHub证书,也不将"知识库"内容复制到网站上. 它初始化已验证的项目/avatar,并通过Asiyst后端获取授权的知识.
await Asiyst.init({
publicKey: "<PUBLIC_KEY>",
});
// throws: Asiyst SDK: projectId is required.
标记重要控件, 使助手可以在布局上找到它们 :
<button data-asiyst="pricing">Pricing</button>
<button
data-asiyst="checkout"
data-asiyst-description="Proceed to checkout"
>
Checkout
</button>
API的生产基础是 https://nqhxpgsjofzqudyqkqib.supabase.co/functions/v1/api。默认情况下使用,只能通过 apiBaseUrl 用于控制下的非生产部署.
如果运行时配置不可用, SDK 保留其本地或符合条件的缓存回落配置 . getConnectionStatus() 单独报告运行时间核查。 访问者聊天需要经过核实的安装和运行时的代号. 云任务规划,工作流程,遥测,和网站地图上传等不属于当前批准的合同内容,不予发送.
文档
- 结构 :
docs/ARCHITECTURE.md - API 和活动 :
docs/API.md - 警卫:
docs/SECURITY.md - 运行时间合同 :
docs/sdk-cli-contract.md - 运行时间细节 :
docs/sdk-runtime.md - 安装 :
docs/sdk-installation.md - 解决问题:
docs/TROUBLESHOOTING.md