@ air/ api- sdk
已键入 JavaScript/ TypeScript SDK 空运 API (英语).
这是您应该安装的主要软件包 。 它再出口所有的东西 @air/api-core 财务报告和审定财务报表 @air/api-rest。 。 。 .
安装
npm install @air/api-sdk
快开始
import { AirApi } from "@air/api-sdk";
const air = new AirApi({
apiKey: "your-api-key",
workspaceId: "your-workspace-id",
});
// List boards
const page = await air.boards.list();
console.log(page.data);
环境变量
您可以设置环境变量,而不是直接传递选项:
export AIR_API_KEY=your-api-key
export AIR_WORKSPACE_ID=your-workspace-id
const air = new AirApi(); // reads from env
配置
const air = new AirApi({
apiKey: "your-api-key", // or AIR_API_KEY env var
workspaceId: "your-workspace-id", // or AIR_WORKSPACE_ID env var
baseURL: "https://api.air.inc/v1", // default
maxRetries: 3, // default, with exponential backoff
timeout: 60_000, // default, in milliseconds
defaultHeaders: {
// optional, sent with every request
"user-agent": "my-app/1.0",
"x-custom-header": "value",
},
});
资源
- 董事会:
air.boards.*(列表、获取、创建、更新、删除、来宾、自定义字段、共享链接) - 显示大小写 :
air.showcases.*(列表、 获取、 创建、 更新、 更新ShareLink、 添加Assets、 删除Asset、 添加Boards、 删除Board) - 资产:
air.assets.*(列表、获取、删除、版本、自定义字段、标签、CDN链接、共享链接) - 标记 :
air.tags.*(列表,获取,创建,更新,删除) - 自定义字段 :
air.customFields.*(列表、创建、更新、删除、数值) - 讨论:
air.discussions.*(列表、 获取、 列表Comments、 创建、 创建、 Comment、 更新、 更新Comment、 删除Comment) - 成员:
air.members.list - 角色 :
air.roles.*(名单) - 上传 :
air.uploads.*(上载有进度跟踪的文件,大型文件的多部分) - 导入 :
air.imports.*(创建,获取状态)
倾斜
列表方法返回a PagePromise 支持自动涂鸦的:
for await (const asset of air.assets.list({ limit: 50 })) {
console.log(asset.id);
}
或手动标注 :
const page = await air.assets.list({ limit: 50 });
console.log(page.data);
if (page.hasNextPage()) {
const next = await page.getNextPage();
}
处理错误
所有 API 错误扩展 APIError根据 HTTP 状态抛出特定错误类别( 400) BadRequestError, 401 (中文(简体) ) AuthenticationError,第403页 PermissionError页:1 NotFoundError429个 RateLimitError, 500+ (单位:千美元) InternalServerError) (中文(简体) ). 可重试错误会自动以指数回放重试.
文档
- 空气开发者 Docs API 参考和指南
- GitHub 仓库 源代码和示例
许可证
麻省理工学院