n8n 中文文档

Grist 凭据

你可以使用这些凭据认证以下节点:

Prerequisites 前提条件

创建一个 Grist 账号。

Supported authentication methods 支持的认证方法

  • API key
  • OAuth2

Related resources 相关资源

有关该服务的更多信息,请参阅 Grist 的 API 文档。

Using API key 使用 API key

要配置此凭据,需要:

  • API Key:在 Grist 中打开右上角的账户菜单,然后前往 Account settings > Developer 创建或复制 API key。有关更多信息,请参阅 Grist API 身份验证文档。
  • Grist URL,用于将 n8n 指向 Grist 服务器:
    • 默认值 https://api.getgrist.com 适用于托管版 Grist(getgrist.com)上的任何账户。
    • 若要将连接限制到单个团队,请使用 https://YOUR_TEAM.getgrist.com。
    • 对于自托管实例,请使用其实例 URL(例如 https://grist.example.com)。

Using OAuth2 使用 OAuth2

在自托管 Grist 中,OAuth 应用属于 Grist 完整版功能。如果你的实例不提供此功能,请使用 API key。

要配置此凭据,需要:

  • Client ID:注册 OAuth 应用时由 Grist 提供。
  • Client Secret:注册 OAuth 应用时由 Grist 提供。
  • Grist URL,用于将 n8n 指向 Grist 服务器:
    • 默认值 https://api.getgrist.com 适用于托管版 Grist(getgrist.com)上的任何账户。
    • 若要将连接限制到单个团队,请使用 https://YOUR_TEAM.getgrist.com。
    • 对于自托管实例,请使用其实例 URL(例如 https://grist.example.com)。

注册应用并连接:

  1. 在 n8n 中开始创建 Grist OAuth2 API 凭据,然后复制 OAuth Redirect URL。
  2. 在 Grist 中打开右上角的账户菜单,然后前往 Account settings > Developer。
  3. 在 OAuth apps 部分选择 Register app。输入 Application name(例如 n8n),并将 n8n 重定向 URL 粘贴为 Redirect URI。
  4. 选择以下 scopes:offline_access、doc:read 和 doc:write。
  5. 选择 Register,然后复制 Client ID 和 Client Secret。Grist 只会显示一次 secret。
  6. 返回 n8n,输入 Client ID 和 Client Secret,然后选择 Connect my account 连接我的账户。
  7. 在 Grist 的授权页面上选择凭据可以访问的内容:选择 All documents (now and in the future),或选择 Selected resources 以挑选单个文档、工作区或站点。然后选择 Authorize。

第 7 步的选择会在 scopes 的基础上进一步缩小凭据的访问范围。Grist 会对每次调用强制执行此限制:即使你本人能够打开授权范围外的文档,对该文档的请求也会失败。将凭据限定到单个文档,是仅向工作流授予所需数据访问权限的好方法。若要日后更改选择,或单独撤销某项凭据的访问权限,请在 Grist 中前往 Account settings > Authorized apps。

有关授权的工作方式和管理方法,请参阅 Grist 已连接应用文档;有关注册应用的详细信息,请参阅 Grist OAuth 应用文档。

提示

注册应用时包含凭据请求的所有 scopes

如果授权请求中包含应用注册时未配置的 scope,Grist 会拒绝该授权,并以 invalid_scope 错误导致连接失败。如果注册应用时配置了较少的 scopes,请使用自定义 scopes,只请求其中已有的 scopes。

提示

至少每月使用一次凭据

Grist 的 refresh token 会在 60 天后过期。至少每 30 天运行一次的工作流可以让凭据持续有效。如果凭据闲置更长时间,请使用 Connect my account 连接我的账户 重新连接。API key 凭据不会过期。

Setting custom scopes 设置自定义 scopes

Grist OAuth2 凭据默认使用以下 scopes:

  • offline_access
  • doc:read
  • doc:write

要为凭据选择不同的 scopes,请启用 Custom Scopes 自定义 scopes 开关,并编辑 Enabled Scopes 已启用 scopes 列表。请注意,使用限制更严格的 scopes 时,某些功能可能无法按预期工作。例如,没有 doc:write 的凭据可以读取记录,但不能创建、更新或删除记录。有关所有可用 scopes,请参阅 Grist OAuth scopes。

不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。