简介

Writer API 是使用 OAuth2.0 协议进行授权的,这允许您在保持用户名和密码私密的同时与任何应用程序共享特定数据。例如,web 应用程序可以使用 OAuth 2.0,以便从最终用户那获取权限在其 Writer 帐户创建文档。

在 OAuth 2.0 中使用了不同类型的令牌。在开始使用授权程前,请看一下以下基本术语。

受保护资源

Writer 的资源,例如,文档和文件夹的列表。

资源服务器

Writer 服务器,用来托管受保护资源。

资源所有者

任何将授予对 Writer 帐户的受保护资源的访问权的最终用户。

授权服务器

对客户端提供必需凭证(例如,访问令牌和刷新令牌的服务器。在此例中,它是指 Writer 服务器。

客户端

客户端是用于发送请求至资源服务器以访问资源的用户应用程序。

授权代码

由授权服务器创建的临时令牌。此信息将通过浏览器发送至客户端以获取访问令牌和刷新令牌。

访问令牌

发送至资源服务器以访问用户的受保护资源的令牌。access_token 将提供对 Writer API 的安全访问,并由应用程序用来发送对所连接应用的请求。access_token 将仅保持有效一小时,且只能用于作用域中指定的操作集合。

刷新令牌

此令牌用于获取新 access_token。它具有无限的生命期,一直有效,直到由最终用户撤销为止。

作用域

您需要用相应的密钥和作用域授权您的应用程序。作用域是一个变量参数,它控制对 access_token 允许的一组资源和操作的访问。在 access-token 请求期间,您的应用程序可在作用域参数中发送一个或多个值。访问令牌和刷新令牌用不同的指定作用域来创建,确保安全的数据访问。

可用的作用域

所有 API:ZohoWriter.documentEditor.ALL

文件夹 API:ZohoWriter.documentEditor.ALL, ZohoPC.files.ALL