Notion API 概述

了解如何利用 Notion 的公共 API 构建集成。

利用 Notion 公共 API 进行集成

Notion 工作区是一个协作环境,团队可以在其中以高度自定义的方式组织工作、管理项目并存储信息。Notion 的 REST API 使开发者能够通过编程直接与工作区中的元素进行交互。主要功能包括:

  • 页面:创建、更新和检索页面内容。
  • 数据库:管理数据库、属性、条目和模式。
  • 用户:访问用户资料和权限。
  • 评论:处理页面和内联评论。
  • 内容查询:搜索工作区中的内容。
  • 认证:通过 OAuth 2.0 进行安全集成。
  • 链接预览:自定义共享链接的显示方式。

为了通过编程与 Notion 工作区进行交互,必须将这些操作与某个 Notion 用户关联。Notion 通过允许 API 请求链接到一个“bot”(机器人)用户来实现这一点。

开发者可以创建集成来定义机器人的功能,包括为 API 请求进行身份验证、决定何时发起请求,以及设置机器人的读/写权限。实际上,使用 Notion 公共 API 需要创建一个集成,该集成概述了机器人如何与您的工作区交互,并将 REST API 请求分配给机器人。

主要有两种集成类型:

  1. 内部集成:用于私人工作区增强。
  2. 公共集成:用于更广泛的、可共享的功能,包括链接预览。

有关集成可能性和 API 详细信息的更多信息,请继续阅读指南或查阅 API 参考。查看我们的演示以获取实际示例。

什么是 Notion 集成?

Notion 集成,有时称为连接,允许开发者以编程方式与 Notion 工作区进行交互。这些集成有助于将 Notion 工作区的数据与其他应用程序链接,或在 Notion 内实现工作流自动化。

集成安装在 Notion 工作区中,并需要用户明确授权以访问 Notion 页面和数据库。

创建 Notion 集成,为团队解锁更多可能性。

Notion 用户可以访问大量现有的集成库,以进一步提升使用体验。对于有兴趣创建自定义解决方案的开发者,Notion 支持开发内部和公共集成。两者都使用 Notion API 与工作区进行交互。

接下来,让我们探索内部集成和公共集成。

内部集成 vs. 公共集成

Notion 集成有两种类型:内部集成公共集成。了解它们之间的区别有助于选择适合您开发需求的正确方法。

  • 内部集成:仅限于一个工作区,只有该工作区的成员可以访问。适用于自定义工作区增强。
  • 公共集成:面向更广泛的用户,适用于任何 Notion 工作区。它们满足广泛的使用场景,并通过 OAuth 2.0 协议进行工作区访问授权。

🔑 公共集成必须通过 Notion 的安全审核后才能发布。

主要区别

特性 内部集成 公共集成
范围 限于单个特定的工作区。 可用于多个不相关的工作区。
用户访问 只有集成所在工作区的成员可以访问。 任何 Notion 用户都可以访问,无论其所属的工作区。
创建 由工作区所有者在集成仪表板内创建。 由工作区所有者在集成仪表板内创建。
权限 工作区成员通过 Notion UI 明确授予页面或数据库访问权限。 用户在 OAuth 流程中授权访问其页面,或直接与集成共享页面。
OAuth 协议 不适用,因访问仅限于单个工作区。 使用 OAuth 2.0 协议,安全访问多个工作区的信息。
仪表板可见性 工作区所有者可以在集成仪表板中查看,包括其他人创建的集成。 -

你可以构建的内容:集成的用例

Notion 的 REST API 为集成带来了无限可能,既可以增强内部工作流程,也可以创建面向公众的应用程序。以下是一些开发者通过 Notion 构建的创新集成的详细案例:

数据集成

数据集成利用 Notion API 来自动化 Notion 和其他系统之间的数据流。

  • 自动通知:开发能够监控 Notion 数据库更改的集成。一旦检测到更改,这些集成可以自动发送通知到不同的通信渠道。
  • GitHub 同步:创建集成,使 Notion 的问题与 GitHub 的问题保持同步。
  • 外部数据导入:构建集成,直接将外部来源的数据导入 Notion 数据库。这可以包括导入客户数据、项目更新或任何其他相关信息。

🔗 示例:

链接预览集成

通过链接预览集成增强 Notion 内的共享体验,提供对共享链接内容的简要预览:

  • GitHub PR 的链接预览:展示 GitHub PR 的链接预览。

创建能够自定义 Notion 中共享链接展示方式的集成,提供上下文信息并提升互动体验。

原文来自:

Notion API Overview
Discover how to leverage Notion’s Public API to build integrations.