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