鍵.png)
使用這些基本 REST API 最佳實(shí)踐構(gòu)建出色的 API
2.填寫信息登錄或注冊(cè)
3.登錄以后訪問開放平臺(tái),點(diǎn)擊頁面中的獲取API-KEY或者點(diǎn)擊鑒權(quán)。(網(wǎng)址:https://docmee.cn/open-platform/)
4.進(jìn)入以后就可以看到密鑰相關(guān)信息。(注意:成功登錄才能看到)
在獲取API密鑰后,進(jìn)行可用性測(cè)試是確保其正常工作的重要步驟。以下是使用curl進(jìn)行測(cè)試的一個(gè)案例
以下接口為 docmee 開放平臺(tái)接口中AI PPT中的 生成 PPT接口
輸入:
curl -X POST --location 'https://docmee.cn/api/ppt/generatePptx' \
--header 'Content-Type: application/json' \
--header 'token: {token}' \
--data '{"outlineContentMarkdown": "xxx", "pptxProperty": false}'
輸出:
你將得到一個(gè)JSON格式的響應(yīng),其中包含了PPT的詳細(xì)信息,如主題、封面、創(chuàng)建時(shí)間、執(zhí)行結(jié)果信息等。
{
"code": 0,
"data": {
? "pptInfo": {
? ? // ppt信息
? ? "id": "xxx", // ppt id
? ? "subject": "xxx", // 主題
? ? "coverUrl": "https://xxx.png", // 封面
? ? "fileUrl": "https://xxx.pptx", // PPT文件
? ? "templateId": "xxx", // 模板ID
? ? "pptxProperty": "xxx", // PPT數(shù)據(jù)結(jié)構(gòu)(json 數(shù)據(jù)通過 gzip 壓縮 base64 編碼返回,具體解碼和數(shù)據(jù)結(jié)構(gòu)請(qǐng)見【PPT前端渲染】部分講解)
? ? "userId": "xxx", // 用戶ID
? ? "userName": "xxx", // 用戶名稱
? ? "companyId": 1000,
? ? "updateTime": null,
? ? "createTime": "2024-01-01 10:00:00"
? }
},
"message": "操作成功"
}
在使用 docmee 開放平臺(tái) API搭建應(yīng)用時(shí),除了獲取和測(cè)試API密鑰外,還需考慮以下因素:
錯(cuò)誤碼 | 說明 |
---|---|
0 | 操作成功(正常) |
-1 | 操作失敗(未知錯(cuò)誤) |
88 | 功能受限(積分已用完 或 非VIP) |
98 | 認(rèn)證失?。z查token是否過期) |
99 | 登錄過期 |
1001 | 數(shù)據(jù)不存在 |
1002 | 數(shù)據(jù)訪問異常 |
1003 | 無權(quán)限訪問 |
1006 | 內(nèi)容涉及敏感信息 |
1009 | AI服務(wù)異常 |
1010 | 參數(shù)錯(cuò)誤 |
1012 | 請(qǐng)求太頻繁,限流 |
SEE 流式請(qǐng)求錯(cuò)誤分兩種
1、初始化流式調(diào)用時(shí)發(fā)生錯(cuò)誤會(huì)返回 application/json 錯(cuò)誤信息
{
?
? ?"code": 1010,
?
? ?"message": "參數(shù)錯(cuò)誤:name 不能為空"
?
}
2、流式過程中遇到錯(cuò)誤,會(huì)在流中返回 text/event-stream 流式錯(cuò)誤信息:
data: {"status":-1, "error":"AI模型執(zhí)行異常"}
API 密鑰:在 docmee 開放平臺(tái)上,需要申請(qǐng) API 密鑰來認(rèn)證請(qǐng)求。確保獲取并正確使用密鑰。
在申請(qǐng)和使用 docmee 開放平臺(tái) API密鑰過程中,你可能會(huì)遇到以下常見問題:
如何處理API錯(cuò)誤響應(yīng)?
當(dāng)API請(qǐng)求返回錯(cuò)誤時(shí),需捕獲錯(cuò)誤響應(yīng),并根據(jù)錯(cuò)誤類型采取相應(yīng)的處理措施。
docmee SDK支持哪些編程語言?
SDK支持多種編程語言,如JavaScript、Python、Java等??梢栽赟DK部分獲取具體的使用指南。
如何查看和管理docmee API請(qǐng)求的訪問日志?
暫時(shí)沒有提供直接管理訪問日志的功能。
在獲得 docmee 開放平臺(tái) API密鑰之后,即可開啟API接口對(duì)接,本文整理了多篇使用 docmee 開放平臺(tái) API的案例,幫助讀者更有效地使用 docmee 開放平臺(tái) API:
隨機(jī) PPT 模板、直接生成PPT、ppt轉(zhuǎn)json、下載 PPT、生成大綱
問題1: 什么是冪簡(jiǎn)集成平臺(tái)?
冪簡(jiǎn)集成是蜜堂有信在2023年打造的一款SAAS產(chǎn)品,建設(shè)著國內(nèi)最全的API平臺(tái),為開發(fā)者提供全面、高效、易用的API集成管理方案,一站搜索、試用、集成國內(nèi)和國外API。讓用戶在AI時(shí)代全方位接入互聯(lián)網(wǎng),用API連接一切服務(wù)和算力,實(shí)現(xiàn)價(jià)值倍增。
問題2:如何找到 docmee 開放平臺(tái) API
冪簡(jiǎn)API平臺(tái)可以通過以下兩種方式找到所需API:通過關(guān)鍵詞搜索API(例如,輸入’ docmee 開放平臺(tái) API‘這類品類詞,更容易找到結(jié)果)、或者從API hub分類頁進(jìn)入尋找。
問題3: docmee 開放平臺(tái) API的替代品有哪些?
市場(chǎng)上存在免費(fèi)、付費(fèi)兩種替代者
例如
gezhe-歌者 PPT – 永久免費(fèi)的 PPT 智能生成工具
更多競(jìng)品可以在 docmee 開放平臺(tái)找到。
本文介紹了在獲取docmee開放平臺(tái)API密鑰后進(jìn)行可用性測(cè)試的步驟,并提供了一個(gè)使用curl進(jìn)行測(cè)試的示例。文章還討論了在使用docmee開放平臺(tái)API時(shí)需要關(guān)注的常見錯(cuò)誤碼、權(quán)限管理,以及如何處理API錯(cuò)誤響應(yīng)等要點(diǎn)。
對(duì)比大模型API的內(nèi)容創(chuàng)意新穎性、情感共鳴力、商業(yè)轉(zhuǎn)化潛力
一鍵對(duì)比試用API 限時(shí)免費(fèi)