@ archastro/ sdk
用于ArchAstro平台API的TypeScript SDK.
文档
API 参考文件公布于 (原始内容存档于2013-10-12). archastro.github.io/archastro-js。 。 。 .
使用此站台分两层 :
- 将SDK接入应用程序、工人或 内部工具.
- 当您知道您需要的资源或方法时使用 API 引用 .
安装
npm install @archastro/sdk
选择一个自定义模式
大多数应用程序集成都使用可公布的API密钥外加用户访问令牌:
import { PlatformClient } from "@archastro/sdk";
const client = PlatformClient.withToken(
process.env.ARCHASTRO_API_KEY ?? "",
process.env.ARCHASTRO_ACCESS_TOKEN ?? "",
);
服务器侧面 Org bots 和工人也可以直接使用应用扫描的用户符:
const client = new PlatformClient({
accessToken: process.env.ARCHASTRO_ACCESS_TOKEN,
});
设定 baseUrl 仅用于当地发展或进行:
import { PlatformClient } from "@archastro/sdk";
const client = PlatformClient.withToken(
process.env.ARCHASTRO_API_KEY ?? "",
process.env.ARCHASTRO_ACCESS_TOKEN ?? "",
process.env.ARCHASTRO_PLATFORM_BASE_URL,
);
快速启动
const me = await client.users.me();
const teams = await client.teams.list();
console.log(me.id, me.email, teams);
反应原生/博览会
盒外的原生移动工程——节点 ws 编号 : events 多填充剂.
使用 PlatformClient.forApp 因此会话存储,无密码的检察官办公室,以及
自动更新停留在一个客户端后面( 不是平行会话帮助器) :
import { PlatformClient, ApiChatChannel, type SessionStorage } from "@archastro/sdk";
const client = PlatformClient.forApp({
publishableKey: process.env.EXPO_PUBLIC_PUBLISHABLE_KEY!,
baseUrl: process.env.EXPO_PUBLIC_API_BASE_URL!,
storage, // your SessionStorage (SecureStore / AsyncStorage)
});
await client.restore();
// client.passwordless… → client.signIn(tokens, user)
await client.agents.list();
const socket = client.createSocket();
见 反应原生指南。 。 。 .
融合指南
- 认证: 为 浏览器会话,服务器侧应用集成,以及org工人.
- 反应原生/博览会: 会话存储, 无密码 auth,以及没有节点多填充的聊天频道.
- 一体化设想: 读取当前用户, 列表 制作一个有片段的特工 上面的片段经过烟雾测试 本地平台 dev 牵引.
- 自定义对象协作: 团队拥有 对象、同源饼干认证、实时快照、重新连接 恢复,存在,和反应清理.
共同资源模式
资源直接挂起 PlatformClient 下 client.v1数字 :
await client.agents.list();
await client.agents.create({
name: "Support triage",
identity: "You triage support requests and keep replies concise.",
});
生成的 API 表面包括已键入的 REST 资源、 认证助手和
频道客户端. 下层凤凰频道客户端记录在
src/phx_channel/README.md。 。 。 .