DOCSPontx Hub
公开文档v1
本页Notion TypeScript 接入

Notion API / TypeScript 实操

用 TypeScript 安全地接入 Notion API。

安装 @pontx/notion,使用本地环境变量验证当前连接身份,再进入 Notion 页面、数据源和块的 API 参考。

01

先确认连接边界

这一页只验证你的集成身份;不会把工作区数据发送给 Pontx。

Notion 工作区内容属于你的最终用户数据。先在 Notion 中创建或选择一个集成,并只给它需要读取的页面或数据源权限。令牌始终保留在本机环境变量中。

02

安装并保留凭证在本机

把令牌交给运行时环境,不要写进源码、命令历史或 issue。

安装与环境变量
pnpm add @pontx/notion

# Keep the value in your local shell or secret manager.
export NOTION_ACCESS_TOKEN="<your-notion-integration-token>"

SDK 会按其固定的 API 版本发送请求。不要在示例里替换成真实令牌;部署环境应通过对应的密钥管理方式提供同名环境变量。

03

先验证当前身份

这是最小的只读调用:它确认令牌可用,却不读取你的页面或数据源。

TypeScript:读取当前身份
import { createNotionClient } from "@pontx/notion";

const client = createNotionClient({
  auth: process.env.NOTION_ACCESS_TOKEN
});

const me = await client.users.getSelf();
console.log(me);

需要先核对请求和本地凭证?使用同包的 CLI 生成 dry-run 预览。

CLI:只预览
pnpm add --global @pontx/notion
pontx-notion call users get-self --dry-run
04

继续到实际工作区任务

连接验证完成后,选择与任务匹配的接口,而不是猜测请求字段。

之后可从 Notion API 概览进入页面、块、数据源、评论和搜索的完整文档。涉及创建、更新或删除工作区数据的请求,应先在本地预览并确认目标与参数。

打开 Notion API 概览