鍵.png)
使用這些基本 REST API 最佳實踐構(gòu)建出色的 API
2.新注冊的用戶需要到填寫的郵箱驗證才能正常登陸賬戶
3.登陸成功以后會進入“控制臺頁面”(新用戶注冊贈送2500積分)
4.從左側(cè)導航欄中進入API密鑰頁面查看自己的密鑰
5.獲取token
方式一:自簽名令牌
您需要使用您的私鑰和公鑰對生成簽名令牌,并將其發(fā)送到每個請求的 Authorization: Bearer {signed_token}
標頭中。
方式二:從官方的認證服務(wù)器請求簽名令牌
當您向 /auth
資源發(fā)送請求時,您將收到一個令牌,用于每個請求(如 /start
、/upload
、/process
、/download
)中的 Authorization: Bearer {signed_token}
標頭中。我們強烈建議您在需要從 /auth
服務(wù)器請求令牌時,啟用域名和 IP 過濾功能。這樣,只有來自您設(shè)定域名的請求才會被接受。請記住,令牌具有過期時間,必須在到期后重新請求。
在獲取API密鑰后,進行可用性測試是確保其正常工作的重要步驟。以下是使用node.js進行測試的一個案例
安裝
npm install @ilovepdf/ilovepdf-nodejs
開始任務(wù)
要啟動任務(wù),您需要直接使用 API 實例創(chuàng)建它:
const ilovepdf = new ILovePDFApi('PUBLIC_KEY');
const myTaskCompress = ilovepdf.newTask('compress'); ? ?
上傳文件
下一步是通過將這些文件添加到任務(wù)中來分配您(或您的用戶)想要上傳的所有文件,如以下代碼示例所示:
myTaskCompress.addFile('path/to/file1_name.pdf');
myTaskCompress.addFile('path/to/file2_name.pdf');
myTaskCompress.addFile('path/to/file3_name.pdf'); ? ?
處理文件
myTaskCompress.process();
下載
最后下載任務(wù)結(jié)果,只需幾行代碼,您就可以壓縮三個 PDF 文件!
myTaskCompress.download(); ?
完整代碼示例
// Authenticate
const ilovepdf = new ILovePDFApi('project_public_id', 'project_secret_key');
?
// Choose your processing tool and create a new task
myTaskCompress = ilovepdf.newTask('compress');
?
// For this example, await notation will be used instead of
// promises.
?
// Add files to task for upload
await myTaskCompress.addFile('path/to/file1_name.pdf');
await myTaskCompress.addFile('path/to/file2_name.pdf');
await myTaskCompress.addFile('path/to/file3_name.pdf');
?
// Execute the task
await myTaskCompress.process();
?
// Download the packaged files
const data = await myTaskCompress.download(); ?
在使用ilovepdf開放平臺 API搭建應(yīng)用時,除了獲取和測試API密鑰外,還需考慮以下因素:
我們采用了一種簡單但有效的認證方法:JWT(JSON Web Tokens)。每個請求需要在 Authorization
標頭中攜帶通過您的 iLovePDF API 開發(fā)者賬戶提供的 Secret Key 簽名生成的令牌(Bearer Token)。
Authorization: Bearer {signed_token}
參數(shù)中發(fā)送。您可以使用您的密鑰對(Secret Key 和 Public Key)生成簽名令牌,并將其添加到每個請求的 Authorization: Bearer {signed_token}
標頭中。
exp
(過期時間)、nbf
(不可用時間)和 iat
(簽發(fā)時間)等聲明必須使用 UTC 時區(qū)。向 /auth
資源發(fā)送請求時,您將收到一個用于每個請求(如 /start
、/upload
、/process
、/download
)的簽名令牌。
所有端點均受到 API 速率限制,具體取決于層。作為每個響應(yīng)的一部分,HTTP 標頭將顯示您當前的速率限制狀態(tài)。
HTTP 錯誤代碼 | 描述 |
---|---|
200 – OK | 請求成功,工作正常。 |
400 – Bad Request | 請求不可接受,通常是因為缺少必要參數(shù)。 |
401 – Unauthorized | 未提供有效的 API 密鑰或密鑰不正確。 |
404 – Not Found | 請求的資源不存在。 |
429 – Too Many Requests | 請求過于頻繁,請求超出速率限制。建議對請求進行指數(shù)回退。 |
5xx – Server Errors | API 服務(wù)器內(nèi)部出現(xiàn)問題。 |
錯誤類型 | 描述 |
---|---|
UploadError | 請求中缺少某些參數(shù)或文件,或者某些操作出錯。 |
ProcessingError | 請求中缺少某些參數(shù)或處理失敗。 |
DownloadError | 文件可能已被移除或過期。 |
在申請和使用 ilovepdf開放平臺 API密鑰過程中,你可能會遇到以下常見問題:
1.訂閱套餐和預付費套餐有什么區(qū)別?
預付費套餐是一次性付款,可為您提供文件處理積分。文件積分不會過期,因此您可以隨時處理購買的文件數(shù)量。這為您的文件處理提供了最大的靈活性。
訂閱計劃每月為您提供固定數(shù)量的文件處理積分。請注意,未使用的文件處理積分將在月底到期。您可以選擇按月或按年訂閱,享受 20% 的折扣。
2.有免費試用嗎?
是的。為了了解 iLoveAPI 是否適合您,我們讓您免費處理前 2500 個每月積分。對于數(shù)字簽名,不提供免費積分。
3.當文件無法處理時會發(fā)生什么? 只有成功處理的文件才會被計數(shù)并從您的信用中扣除。如果您訂閱了月度計劃并且還購買了預付費套餐,則文件將始終首先從您的月度計劃積分中扣除。在同一任務(wù)中合并多個 PDF 文件時,這將被計為正在處理的一個文件。
4.當我達到文件處理限制時會發(fā)生什么? 一旦您使用了 85% 的文件額度,我們將通過電子郵件通知您,以便您及時升級訂閱或購買預付費套餐。
在獲得ilovepdf開放平臺 API密鑰之后,即可開啟API接口對接,本文整理了多篇使用ilovepdf開放平臺 API的案例,幫助讀者更有效地使用ilovepdf開放平臺 API:
拆分 PDF、 壓縮 PDF、 將 Office 轉(zhuǎn)換為 PDF、 HTML 轉(zhuǎn) PDF、 將圖像轉(zhuǎn)換為 PDF
問題1: 什么是冪簡集成平臺?
冪簡集成是蜜堂有信在2023年打造的一款SAAS產(chǎn)品,建設(shè)著國內(nèi)最全的API平臺,為開發(fā)者提供全面、高效、易用的API集成管理方案,一站搜索、試用、集成國內(nèi)和國外API。讓用戶在AI時代全方位接入互聯(lián)網(wǎng),用API連接一切服務(wù)和算力,實現(xiàn)價值倍增。
問題2:如何找到ilovepdf開放平臺 API
冪簡API平臺可以通過以下兩種方式找到所需API:通過關(guān)鍵詞搜索API(例如,輸入’ilovepdf開放平臺 API‘這類品類詞,更容易找到結(jié)果)、或者從API hub分類頁進入尋找。
問題3:ilovepdf開放平臺 API的替代品有哪些?
市場上存在免費、付費兩種替代者
例如
更多競品可以在ilovepdf開放平臺找到。
在本文中,我們詳細介紹了如何使用ilovepdf開放平臺API,包括API密鑰的獲取和可用性測試、如何進行文件上傳、處理和下載操作。此外,還探討了在構(gòu)建應(yīng)用時需要注意的認證方式、速率限制以及常見的HTTP錯誤代碼。同時,我們回答了一些與API申請和使用相關(guān)的常見問題,并提供了關(guān)于文件處理額度和免費試用的信息。最后,我們還分享了更多的API使用案例,幫助開發(fā)者更好地利用ilovepdf開放平臺API實現(xiàn)各種PDF處理功能。