0

0

石墨文档如何实现API接口调用_石墨文档开放平台的使用入门

看不見的法師

看不見的法師

发布时间:2025-10-29 23:52:01

|

262人浏览过

|

来源于php中文网

原创

首先注册应用获取App ID和App Secret,然后通过OAuth 2.0授权流程用code换取access_token,最后携带token调用文档创建、读取、更新等API实现自动化操作。

石墨文档如何实现api接口调用_石墨文档开放平台的使用入门

石墨文档开放平台为开发者提供了便捷的 API 接口,可用于实现文档创建、读取、更新、权限管理等自动化操作。要实现 API 调用,需完成注册、授权、获取凭证和发起请求几个关键步骤。

注册并创建应用

使用石墨文档 API 的第一步是在石墨开放平台注册账号并创建应用:

  • 登录后进入“我的应用”页面,点击“创建应用”
  • 填写应用名称、描述和回调地址(用于 OAuth2 授权)
  • 创建成功后,系统会生成 App IDApp Secret,这是后续调用接口的身份凭证

获取访问令牌(Access Token)

石墨 API 使用 OAuth 2.0 协议进行授权。你需要通过以下流程获取用户的访问权限:

  1. 构造授权 URL,引导用户跳转:
    https://account.shimo.im/oauth/authorize?client_id=YOUR_APP_ID&redirect_uri=YOUR_REDIRECT_URI&response_type=code
  2. 用户授权后,石墨会重定向到你设定的回调地址,并附带一个临时的 code
  3. 使用该 code 向 token 接口发起 POST 请求,换取 access_token:

请求示例:

POST https://account.shimo.im/oauth/token
Content-Type: application/json

{ "client_id": "your_app_id", "client_secret": "your_app_secret", "grant_type": "authorization_code", "code": "received_code", "redirect_uri": "your_redirect_uri" }

成功后将返回包含 access_token 的 JSON 数据,有效期通常为 2 小时。

调用文档相关 API

拿到 access_token 后,即可调用具体的文档操作接口。例如创建一个新文档:

白果AI论文
白果AI论文

论文AI生成学术工具,真实文献,免费不限次生成论文大纲 10 秒生成逻辑框架,10 分钟产出初稿,智能适配 80+学科。支持嵌入图表公式与合规文献引用

下载
POST https://api.shimo.im/docs
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{ "title": "我的自动化文档", "folder_id": "optional_folder_id" }

常见接口包括:

  • GET /docs:获取用户文档列表
  • GET /docs/{docId}:获取文档元信息
  • PATCH /docs/{docId}:修改文档标题或位置
  • PUT /docs/{docId}/content:写入文档内容(支持 Markdown 或 JSON 格式)
  • POST /shares:设置文档分享权限

处理响应与错误

API 返回标准 JSON 格式数据。成功时状态码为 200 或 201,结构类似:

{ "id": "abc123xyz", "title": "我的自动化文档", "created_at": "2023-07-01T10:00:00Z" }

出错时会返回错误码和提示,如:

  • 401 Unauthorized:access_token 无效或过期,需重新授权
  • 403 Forbidden:无权访问目标文档
  • 429 Too Many Requests:请求频率超限,建议增加间隔

基本上就这些。只要正确配置应用、获取 token 并按文档格式调用接口,就能实现对石墨文档的程序化控制。建议在测试环境先用个人账号验证流程,再集成到正式系统中。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

413

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

533

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

310

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

75

2025.09.10

登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

6099

2023.09.14

登录token无效怎么办
登录token无效怎么办

登录token无效的解决办法有检查Token是否过期、检查Token是否正确、检查Token是否被篡改、检查Token是否与用户匹配、清除缓存或Cookie、检查网络连接和服务器状态、重新登录或请求新的Token、联系技术支持或开发人员等。本专题为大家提供token相关的文章、下载、课程内容,供大家免费下载体验。

810

2023.09.14

token怎么获取
token怎么获取

获取token值的方法:1、小程序调用“wx.login()”获取 临时登录凭证code,并回传到开发者服务器;2、开发者服务器以code换取,用户唯一标识openid和会话密钥“session_key”。想了解更详细的内容,可以阅读本专题下面的文章。

1062

2023.12.21

token什么意思
token什么意思

token是一种用于表示用户权限、记录交易信息、支付虚拟货币的数字货币。可以用来在特定的网络上进行交易,用来购买或出售特定的虚拟货币,也可以用来支付特定的服务费用。想了解更多token什么意思的相关内容可以访问本专题下面的文章。

1265

2024.03.01

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

19

2026.01.20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
CSS3 教程
CSS3 教程

共18课时 | 4.7万人学习

MongoDB 教程
MongoDB 教程

共17课时 | 2.2万人学习

CSS教程
CSS教程

共754课时 | 21.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号