鍵.png)
使用NestJS和Prisma構(gòu)建REST API：身份驗證
1.授權(quán)成功后
2.通過 code，調(diào)用 getAccessToken 接口
請求方法：GET
請求路徑：/api/v1/openapi/user/basic
請求主機：developer.kdocs.cn
| 應(yīng)用類型 | 限額 |
|---|---|
| 測試應(yīng)用 | 10,000 次/天 |
| 正式應(yīng)用 | 1,000,000 次/天 |
| 權(quán)限值 | 顯示名稱 | 權(quán)限說明 |
|---|---|---|
| user_basic | 用戶基本信息 | 訪問用戶基本信息 |
| 參數(shù) | 必須 | 類型 | 說明 |
|---|---|---|---|
| access_token | 是 | string | 訪問令牌 |
| 參數(shù) | 類型 | 說明 |
|---|---|---|
| code | integer | 錯誤碼 |
| +data | data {} | 響應(yīng)數(shù)據(jù) |
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"
}
}Q：如何找到金山文檔 API
A：冪簡集成是國內(nèi)領(lǐng)先的API集成管理平臺，專注于為開發(fā)者提供全面、高效、易用的API集成解決方案。冪簡API平臺可以通過以下兩種方式找到所需API：通過關(guān)鍵詞搜索API(例如，輸入’金山文檔 API‘這類品類詞，更容易找到結(jié)果)、或者從API hub分類頁進(jìn)入尋找。
Q：創(chuàng)建文檔、獲取文檔或用戶信息時，返回的數(shù)據(jù)中的 open_id 或 union_id 是什么意思？
A：
open_id 為文檔或用戶在一個應(yīng)用下的唯一標(biāo)識，同個文件對于不同應(yīng)用來說，open_id 是不一樣的，即使這些應(yīng)用屬于同一個服務(wù)商。
union_id 為文檔或用戶在一個服務(wù)商下的唯一標(biāo)識，同個文件對于同服務(wù)商的不同應(yīng)用來說是相同的，不同服務(wù)商之間 union_id 是不同的。
union_id 提供了一種在服務(wù)商下，打通多個應(yīng)用數(shù)據(jù)的方式。
Q：在文檔相關(guān)接口的使用過程中，要求傳入 file_token 時，我們該如何獲取此參數(shù)以及它的含義是什么？
A：file_token 即文檔 ID，可以通過其它接口例如創(chuàng)建文檔、獲取文檔列表等拿到文檔 id 對象，此對象內(nèi)包含 union_id 和 open_id 兩個字段，這兩個字段均可以作為 file_token 使用。當(dāng)需要對應(yīng)用做區(qū)分時，使用 open_id，當(dāng)需要打通服務(wù)商下的多個應(yīng)用的數(shù)據(jù)時，使用 union_id。
Q：在用戶相關(guān)接口的使用過程中，要求傳入 user_id 時，我們該如何獲取此參數(shù)以及它的含義是什么？
A：user_id 即用戶 ID，可以通過獲取用戶信息接口拿到，此對象內(nèi)包含 union_id 和 open_id 兩個字段，這兩個字段均可以作為 user_id 使用。當(dāng)需要對應(yīng)用做區(qū)分時，使用 open_id，當(dāng)需要打通服務(wù)商下的多個應(yīng)用的數(shù)據(jù)時，使用 union_id。
Q：API-KEY被刪除會有什么影響？
A：目前支持主賬號對API-KEY的刪除，子賬號無法進(jìn)行操作。刪除的API-KEY無法找回也無法使用，但您在調(diào)用統(tǒng)計頁面仍能查詢被刪除的API-KEY以往的調(diào)用統(tǒng)計結(jié)果。
Q：新上架的模型是否需要重新開通？
A：當(dāng)您已完成服務(wù)開通后，DashScope提供的模型有新增或迭代時，您無需重新開通即可直接按照流程進(jìn)行調(diào)用。
提供AI大模型API的服務(wù)商除了金山文檔 API，還有其他替代服務(wù)商也提供類似api服務(wù)，例如：
repsona API開放平臺、BoldSign API開放平臺、surfsara API開放平臺
更多競品可以在冪簡集成開放平臺中找到。
Q：金山文檔 API這個密鑰還適用于哪些api？
獲取臨時憑證、獲取文檔列表（扁平）、通過云盤文檔創(chuàng)建文檔
本文全面且細(xì)致地介紹了獲取金山文檔API開放平臺訪問token的完整流程，為開發(fā)者們提供了一份條理清晰、操作簡便的分步指南。從金山文檔API開放平臺的賬號注冊，到完成開發(fā)者身份認(rèn)證，再到最終成功獲取訪問token，每一步操作都配備了詳盡的說明與指導(dǎo)，旨在確保開發(fā)者能夠輕松、準(zhǔn)確地完成整個流程。獲取訪問token只是利用金山文檔API的第一步，如何高效、穩(wěn)定地集成并應(yīng)用這些API才是關(guān)鍵。因此，在本文中，我們不僅指導(dǎo)了如何獲取訪問token，還特別強調(diào)了獲取后進(jìn)行功能驗證與可用性測試的重要性。這是確保金山文檔API能夠順利集成到應(yīng)用中，并發(fā)揮出最佳性能與效果的關(guān)鍵一環(huán)。通過本文的指引，我們旨在為開發(fā)者們構(gòu)建一個全面、詳盡且極具實用性的操作手冊，幫助他們輕松獲取金山文檔API開放平臺的訪問token，并將這一強大的文檔處理能力高效地集成到應(yīng)用中。我們相信，隨著開發(fā)者們對這一指南的深入理解和實踐，將能夠顯著提升應(yīng)用的文檔處理能力與用戶體驗，從而在軟件開發(fā)與數(shù)字服務(wù)創(chuàng)新的道路上邁出更加堅實的一步。
