所有文章 > 学习各类API > 金山文档 API开放平台访问token分步指南

金山文档 API开放平台访问token分步指南

在当今数字化迅猛发展的时代,API开放平台已成为连接开发者与创新应用的桥梁,极大地推动了数字媒体、软件开发及日常生活的智能化进程。金山文档,作为一款功能强大的在线文档编辑工具,其API开放平台不仅提供了丰富的文档处理功能,还允许开发者通过API接口将这些功能无缝集成到自己的应用中。无论是企业级的文档管理解决方案,还是个人开发者想要打造的高效协作工具,金山文档API都为其提供了强有力的支持。本文将详细指导你如何获取金山文档API开放平台的访问token,这是开启与金山文档API进行交互的第一步。我们将从注册开发者账号开始,逐步带你完成身份认证、申请API权限,并最终成功获取访问token。同时,我们还将分享一些在获取和使用访问token过程中需要注意的关键事项,以确保你能够顺利、高效地将金山文档API集成到你的应用中,从而为用户提供更加丰富、便捷的功能体验。

1. 登录授权

  1. 业务前端(本示例为 demo.kdocs.cn),首先点击跳转授权按钮
跳转授权
  1. 跳转授权地址
授权页
  1. 授权成功后
授权成功

2. 获取token

1.授权成功后

授权成功

2.通过 code,调用 getAccessToken 接口

获取token

3. 代码接入

基本信息

请求方法:GET

请求路径:/api/v1/openapi/user/basic

请求主机:developer.kdocs.cn

限流频次

应用类型限额
测试应用10,000 次/天
正式应用1,000,000 次/天

权限范围

权限值显示名称权限说明
user_basic用户基本信息访问用户基本信息

Query 参数

参数必须类型说明
access_tokenstring访问令牌

返回参数

参数类型说明
codeinteger错误码
+datadata {}响应数据

示例

请求示例

Shell

curl --request GET \
--url https://developer.kdocs.cn/api/v1/openapi/user/basic

返回示例

{
"code": 0,
"data": {
"id": {
"open_id": "c_clA7pUx2rhUrVFLfWOLhJicivSiSgDEpy4v0RopRs",
"union_id": "CrcVtuipxn2iHgJB56IOyJfGBNZSq8KNy369rn7u1Z8"
},
"nickname": "11",
"avatar": "https://imagebucket.test.wpscdn.cn/11"
}
}

4. 常见问题

Q:如何找到金山文档 API

A:幂简集成是国内领先的API集成管理平台,专注于为开发者提供全面、高效、易用的API集成解决方案。幂简API平台可以通过以下两种方式找到所需API:通过关键词搜索API(例如,输入’金山文档 API‘这类品类词,更容易找到结果)、或者从API hub分类页进入寻找。

Q:创建文档、获取文档或用户信息时,返回的数据中的 open_id 或 union_id 是什么意思?
A:

open_id 为文档或用户在一个应用下的唯一标识,同个文件对于不同应用来说,open_id 是不一样的,即使这些应用属于同一个服务商。

union_id 为文档或用户在一个服务商下的唯一标识,同个文件对于同服务商的不同应用来说是相同的,不同服务商之间 union_id 是不同的。

union_id 提供了一种在服务商下,打通多个应用数据的方式。

Q:在文档相关接口的使用过程中,要求传入 file_token 时,我们该如何获取此参数以及它的含义是什么?
A:file_token 即文档 ID,可以通过其它接口例如创建文档、获取文档列表等拿到文档 id 对象,此对象内包含 union_id 和 open_id 两个字段,这两个字段均可以作为 file_token 使用。当需要对应用做区分时,使用 open_id,当需要打通服务商下的多个应用的数据时,使用 union_id。

Q:在用户相关接口的使用过程中,要求传入 user_id 时,我们该如何获取此参数以及它的含义是什么?
A:user_id 即用户 ID,可以通过获取用户信息接口拿到,此对象内包含 union_id 和 open_id 两个字段,这两个字段均可以作为 user_id 使用。当需要对应用做区分时,使用 open_id,当需要打通服务商下的多个应用的数据时,使用 union_id。

Q:API-KEY被删除会有什么影响?
A:目前支持主账号对API-KEY的删除,子账号无法进行操作。删除的API-KEY无法找回也无法使用,但您在调用统计页面仍能查询被删除的API-KEY以往的调用统计结果。

Q:新上架的模型是否需要重新开通?

A:当您已完成服务开通后,DashScope提供的模型有新增或迭代时,您无需重新开通即可直接按照流程进行调用。

Q:金山文档 API的替代品有哪些?

提供AI大模型API的服务商除了金山文档 API,还有其他替代服务商也提供类似api服务,例如:

repsona API开放平台BoldSign API开放平台surfsara API开放平台

更多竞品可以在幂简集成开放平台中找到。

Q:金山文档 API这个密钥还适用于哪些api?

获取临时凭证获取文档列表(扁平)通过云盘文档创建文档

5.  总结

本文全面且细致地介绍了获取金山文档API开放平台访问token的完整流程,为开发者们提供了一份条理清晰、操作简便的分步指南。从金山文档API开放平台的账号注册,到完成开发者身份认证,再到最终成功获取访问token,每一步操作都配备了详尽的说明与指导,旨在确保开发者能够轻松、准确地完成整个流程。获取访问token只是利用金山文档API的第一步,如何高效、稳定地集成并应用这些API才是关键。因此,在本文中,我们不仅指导了如何获取访问token,还特别强调了获取后进行功能验证与可用性测试的重要性。这是确保金山文档API能够顺利集成到应用中,并发挥出最佳性能与效果的关键一环。通过本文的指引,我们旨在为开发者们构建一个全面、详尽且极具实用性的操作手册,帮助他们轻松获取金山文档API开放平台的访问token,并将这一强大的文档处理能力高效地集成到应用中。我们相信,随着开发者们对这一指南的深入理解和实践,将能够显著提升应用的文档处理能力与用户体验,从而在软件开发与数字服务创新的道路上迈出更加坚实的一步。

#你可能也喜欢这些API文章!