Tegon API完全参考：从基础调用到高级集成

Tegon API完全参考：从基础调用到高级集成

【免费下载链接】tegonTegon is an open-source, dev-first alternative to Jira, Linear项目地址: https://gitcode.com/gh_mirrors/te/tegon

Tegon作为开源的开发者优先替代方案，提供了强大的API系统支持从简单数据操作到复杂工作流集成的各种需求。本文将全面介绍Tegon API的基础调用方法、核心功能模块及高级集成技巧，帮助开发者快速上手并实现高效自动化。

快速开始：API基础设置

要开始使用Tegon API，首先需要安装官方SDK。通过以下命令可以快速集成到你的项目中：

```bash npm npm i @tegonhq/sdk@0.1.3 ```

pnpm add @tegonhq/sdk@0.1.3

yarn add @tegonhq/sdk@0.1.3

配置SDK只需提供认证令牌，推荐通过环境变量TEGON_TOKEN设置：

import { configure } from "@tegonhq/sdk"; configure({ token: "your_auth_token_here", // 或省略以使用环境变量 });

图1：Tegon API认证设置界面，显示如何创建和管理访问令牌

核心API端点详解

Tegon API采用RESTful设计风格，主要端点覆盖了项目管理的核心功能：

1. 问题管理API

• 创建问题：POST /api/v1/issues
• 获取问题：POST /api/v1/issues/filter
• 更新问题：POST /api/v1/issues/{issueId}
• 删除问题：DELETE /api/v1/issues/{issueId}

示例：创建新问题

import { createIssue } from "@tegonhq/sdk"; const newIssue = await createIssue({ title: "API集成问题", description: "需要优化用户认证流程", priority: "high", assigneeId: "user_123" });

2. 标签管理API

• 创建标签：POST /api/v1/labels
• 获取标签列表：GET /api/v1/labels
• 更新标签：POST /api/v1/labels/{labelId}
• 删除标签：DELETE /api/v1/labels/{labelId}

3. 集成账户API

• 获取集成账户：GET /api/v1/integration_account/{integrationAccountId}
• 获取账户ID：GET /api/v1/integration_account/accountId

图2：Tegon API与Slack集成的配置界面，展示第三方服务连接设置

高级功能：AI请求与工作流

Tegon API提供了AI辅助功能，可通过以下端点实现智能交互：

• 创建AI请求：POST /api/v1/ai_requests
• 流式AI响应：POST /api/v1/ai_requests/stream

示例：使用AI生成问题摘要

import { createAiRequest } from "@tegonhq/sdk"; const aiResponse = await createAiRequest({ prompt: "总结以下问题内容并提取关键要点", context: issue.description, model: "gpt-4" });

对于工作流自动化，可使用Action API：

• 运行Action：POST /api/v1/action/{slug}/run
• 更新Action输入：POST /api/v1/action/{slug}/inputs

图3：Tegon Action工作流配置界面，展示如何设置触发条件和执行步骤

实用场景示例

1. 项目看板数据同步

通过API实现外部系统与Tegon看板的实时同步：

// 获取项目视图数据 import { getView } from "@tegonhq/sdk"; const viewData = await getView({ viewId: "view_456", filters: { status: "in_progress" } }); // 同步到外部系统 syncToExternalSystem(viewData.issues);

图4：Tegon看板视图展示，API可获取类似的结构化数据用于外部集成

2. 跨平台问题链接

使用链接问题API实现不同系统间的问题追踪关联：

import { createLinkedIssue } from "@tegonhq/sdk"; const linkedIssue = await createLinkedIssue({ issueId: "issue_789", source: "github", sourceId: "PR-1234", sync: true });

最佳实践与注意事项

1. 认证安全：始终通过环境变量管理令牌，避免硬编码
2. 请求限流：API默认限制每分钟60次请求，批量操作建议添加延迟
3. 错误处理：实现重试机制处理临时网络问题
4. 版本控制：SDK版本应与API版本保持一致，推荐锁定版本号

完整的API文档可参考项目中的docs/api-reference/overview.mdx，包含所有端点的详细参数说明和响应格式。

图5：Tegon API文档界面预览，展示完整的端点列表和使用示例

通过Tegon API，开发者可以构建从简单集成到复杂自动化的各种解决方案，充分发挥Tegon作为项目管理工具的灵活性和扩展性。无论是自定义工作流、外部系统集成还是AI辅助功能，API都提供了坚实的基础支持。

【免费下载链接】tegonTegon is an open-source, dev-first alternative to Jira, Linear项目地址: https://gitcode.com/gh_mirrors/te/tegon