鍵.png)
使用這些基本 REST API 最佳實(shí)踐構(gòu)建出色的 API
2.創(chuàng)建賬戶以后到郵箱中需要驗(yàn)證。
3.登錄成功以后就會進(jìn)入到控制臺頁面。
4.點(diǎn)擊左側(cè)導(dǎo)航欄中的 API訪問 ,在當(dāng)前頁面就可以看到密鑰相關(guān)信息。
在獲取API密鑰后,進(jìn)行可用性測試是確保其正常工作的重要步驟。以下是使用curl進(jìn)行測試的一個案例
以下接口為SupaRes 開放平臺接口中面部增強(qiáng)接口
輸入:
curl https://api.supares.com/1.0/fetch
--user your-api-key: \
--header "Content-Type: application/json" \
--data '{
"url": "https://www.website.com/image.jpg",
"face": {
"enhance": true
}
}'
對于圖像處理端點(diǎn)/1.0/upload
和/1.0/fetch
的每個請求,API 將立即返回一個唯一的請求id
,狀態(tài)代碼為202 Accepted
。
輸出:
{
"success": true,
"code": 202,
"id": "051d58e6-2ef8-4dcc-bc9b-bd76bd8b124f"
}
訪問增強(qiáng)以后的圖片
SupaRes API 公開/1.0/results/{id}
端點(diǎn),您可以使用該端點(diǎn)通過簡單的輪詢機(jī)制獲取請求的結(jié)果。例如:
輸入
curl -u your-api-key: https://api.supares.com/1.0/results/051d58e6-2ef8-4dcc-bc9b-bd76bd8b124f
輸出結(jié)果
包含了圖像的相關(guān)信息,例如url地址圖像的大小等信息。
{
"success": true,
"code": 200,
"id": "051d58e6-2ef8-4dcc-bc9b-bd76bd8b124f",
"status": "ready",
"url": "https://s3.supares.com/temp-supares/JMxbLxAomXi55re4D5zV/051d58e6-2ef8-4dcc-bc9b-bd76bd8b124f/1-input.webp",
"metadata": {
"format": "webp",
"width": 500,
"height": 200,
"bytes": 23718,
"space": "srgb",
"channels": 3
}
}
在使用SupaRes 開放平臺 API搭建應(yīng)用時,除了獲取和測試API密鑰外,還需考慮以下因素:
對 API 的所有請求都必須使用HTTP Basic Auth或Bearer Auth通過您唯一的 API 密鑰進(jìn)行身份驗(yàn)證。使用 HTTP 基本身份驗(yàn)證時,您必須提供 API 密鑰作為用戶名值。您不需要提供密碼。如果您需要使用 Authorization 標(biāo)頭通過 Bearer Auth 進(jìn)行身份驗(yàn)證,則必須將 API 密鑰設(shè)置為憑據(jù)。
所有 API 請求都必須使用 HTTPS 協(xié)議發(fā)出,以便對流量進(jìn)行加密。通過純 HTTP 進(jìn)行的調(diào)用以及未經(jīng)身份驗(yàn)證的請求都會失敗。
為了保護(hù) SupaRes 平臺并確保系統(tǒng)資源的公平分配,所有請求,無論使用哪種 HTTP 方法和端點(diǎn),都按每個密鑰進(jìn)行速率限制。速率限制分為 15 分鐘間隔,您每 15 分鐘最多可以發(fā)出100,000 (十萬)個請求,這對于合理使用來說綽綽有余(大約每秒 110 個請求)。您將在每個響應(yīng)中找到標(biāo)準(zhǔn)X-RateLimit-*
標(biāo)頭,以幫助您跟蹤使用情況。
X-RateLimit-Limit: 100000 | 當(dāng)期允許的請求數(shù) |
---|---|
X-RateLimit-Remaining: 2120 | 本期剩余請求數(shù) |
X-RateLimit-Reset: 778 | 當(dāng)前時間段剩余秒數(shù) |
SupaRes API 返回傳統(tǒng)的 HTTP 響應(yīng)代碼以指示 API 請求的成功或失敗。成功的請求將始終產(chǎn)生2xx
代碼范圍。 4xx
范圍內(nèi)的狀態(tài)代碼通常表示發(fā)送的請求存在問題(例如省略了必需的參數(shù))。如果您收到5xx
范圍內(nèi)的狀態(tài),這通常表明存在服務(wù)器端問題,并且意味著我們這邊遇到問題,當(dāng)前無法滿足您的請求。
在申請和使用 SupaRes 開放平臺 API密鑰過程中,你可能會遇到以下常見問題:
提供免費(fèi)計(jì)劃嗎?
我們提供免費(fèi)計(jì)劃,并且注冊不需要信用卡。每次注冊一開始都是免費(fèi)計(jì)劃,一次性配額為 10 個積分。
我可以稍后更改計(jì)劃嗎?
您可以在付費(fèi)計(jì)劃之間切換,或者隨時完全取消您的帳戶。我們將相應(yīng)地調(diào)整任何付款。
積分如何運(yùn)作?
1 個積分等于處理 1 張圖像。我們不會對每次操作收取任何額外費(fèi)用。這意味著您可以在一張圖像上應(yīng)用我們提供的每一種人工智能圖像增強(qiáng)功能,我們將從您的帳戶中扣除一筆積分。
需要信用卡才能注冊嗎? 如果您選擇購買按月訂閱,則只會要求您提供信用卡或借記卡。您無需輸入任何付款信息即可開始免費(fèi)計(jì)劃。
在獲得SupaRes 開放平臺 API密鑰之后,即可開啟API接口對接,本文整理了多篇使用SupaRes 開放平臺 API的案例,幫助讀者更有效地使用SupaRes 開放平臺 API:
音調(diào)調(diào)整、 噪音消除、 減少偽影、 圖像優(yōu)化、 圖片上傳、 圖像獲取
問題1: 什么是冪簡集成平臺?
冪簡集成是蜜堂有信在2023年打造的一款SAAS產(chǎn)品,建設(shè)著國內(nèi)最全的API平臺,為開發(fā)者提供全面、高效、易用的API集成管理方案,一站搜索、試用、集成國內(nèi)和國外API。讓用戶在AI時代全方位接入互聯(lián)網(wǎng),用API連接一切服務(wù)和算力,實(shí)現(xiàn)價值倍增。
問題2:如何找到SupaRes 開放平臺 API
冪簡API平臺可以通過以下兩種方式找到所需API:通過關(guān)鍵詞搜索API(例如,輸入’SupaRes 開放平臺 API‘這類品類詞,更容易找到結(jié)果)、或者從API hub分類頁進(jìn)入尋找。
問題3:SupaRes 開放平臺 API的替代品有哪些?
市場上存在免費(fèi)、付費(fèi)兩種替代者
例如
更多競品可以在SupaRes 開放平臺找到。
本文詳細(xì)介紹了如何獲取和測試SupaRes開放平臺API密鑰,并提供了使用curl進(jìn)行可用性測試的具體示例。通過測試,開發(fā)者能夠確認(rèn)API的正常工作,并了解如何通過輪詢機(jī)制獲取處理后的圖像。文章還探討了在使用SupaRes API時需要注意的關(guān)鍵因素,如身份驗(yàn)證、速率限制和錯誤處理等,幫助開發(fā)者更好地集成該平臺的圖像處理功能。