概览
快速入门
几分钟内从零开始完成第一次 API 调用（另加我们审批您访问权限所需的时间）。
1. 申请开发者权限#
API 向所有 Linework 用户开放，但访问权限需要人工审核，以确保机器人真正有用并拦截垃圾信息。
- 登录 Web 应用并打开 web.linework.app → 设置 → 开发者。
- 填写申请：
- 用例 — 用几句话说明您的集成做什么（例如“发布我餐厅的每日菜单，并在聊天中回复问题”）。
- 网站 — 您的网站或项目页面（如有）。
- 机器人名称 — 您的应用或机器人的名称，会显示给我们，也会出现在您的密钥列表中。
- 提交申请。您可以在同一页面查看状态（待审核、已批准或已拒绝）。
API 作用于您自己的账号。如果机器人需要有自己的身份（例如“Pizza Roma Bot”），请为它单独创建一个 Linework 账号，设置头像和封面图，并从该账号申请访问权限。
2. 创建 API 密钥#
访问权限获批后，即可在开发者页面创建 API 密钥：
- 点击创建密钥，为其命名（例如“store-sync production”）。
- 只选择集成所需的权限范围。
- 复制密钥。密钥形如
lwk_后接 40 个字符，并且只显示一次。
请将其保存在环境变量或密钥管理器中，切勿写入源代码：
export LINEWORK_API_KEY="lwk_your_key_here"关于密钥、限制和吊销的更多信息，请参阅身份验证与 API 密钥。
3. 发出第一次调用#
GET /me 返回密钥所属的账号。这是检查一切是否正常的最快方式。
curl -i https://api.linework.app/open/v1/me \
-H "Authorization: Bearer $LINEWORK_API_KEY"const res = await fetch("https://api.linework.app/open/v1/me", {
headers: { Authorization: `Bearer ${process.env.LINEWORK_API_KEY}` },
});
if (!res.ok) throw new Error(JSON.stringify(await res.json()));
console.log(await res.json());import os, requests
r = requests.get(
"https://api.linework.app/open/v1/me",
headers={"Authorization": f"Bearer {os.environ['LINEWORK_API_KEY']}"},
timeout=30,
)
r.raise_for_status()
print(r.json())成功的响应是一个描述您个人资料的 JSON 对象。如果收到 401 INVALID_API_KEY，请检查请求头是否完全是 Authorization: Bearer lwk_…，以及密钥是否已被吊销。确切的响应字段请参阅 API 参考。