鍵.png)
使用這些基本 REST API 最佳實(shí)踐構(gòu)建出色的 API
2.去郵箱中找到官方發(fā)過來的驗(yàn)證碼。
3.登錄以后會自動(dòng)跳轉(zhuǎn)到儀表盤頁面,會提示選擇一個(gè)訂閱,這里根據(jù)自己需要選擇對應(yīng)的訂閱。(案例以免費(fèi)版本演示)點(diǎn)擊獲取免費(fèi)的API密鑰
4.點(diǎn)擊以后就會進(jìn)入到API密鑰管理頁面,可以新建一個(gè)密鑰。
5.新建以后就可以看到每個(gè)API密鑰的詳細(xì)信息。
在獲取API密鑰后,進(jìn)行可用性測試是確保其正常工作的重要步驟。以下是使用curl進(jìn)行測試的一個(gè)案例
以下接口為 cypto 開放平臺 接口中錢包即服務(wù)中的 創(chuàng)建新的主錢包接口
輸入:
curl -X POST "https://rest.cryptoapis.io/wallet-as-a-service/wallets/generate?context=yourExampleString" \
-H "Content-Type: application/json" \
-H "x-api-key: <Your_API_Key>" \
-d '{
? "context": "yourExampleString",
? "data": {
? ? ? "item": {
? ? ? ? ? "walletName": "yourWalletName",
? ? ? ? ? "walletType": "test"
? ? ? }
? }
}'
?
輸出:
你將得到一個(gè)JSON格式的響應(yīng),其中包含了有關(guān)錢包ID的信息。
{
? "apiVersion": "2023-04-25",
? "requestId": "601c1710034ed6d407996b30",
? "context": "yourExampleString",
? "data": {
? ? ? "item": {
? ? ? ? ? "walletId": "62b9b5c3b97f4b0108092716"
? ? ? }
? }
}
在使用 cypto 開放平臺 API搭建應(yīng)用時(shí),除了獲取和測試API密鑰外,還需考慮以下因素:
要使用和調(diào)用任何加密 API 產(chǎn)品,您必須創(chuàng)建 API 密鑰,以便對您的請求進(jìn)行身份驗(yàn)證。
API 密鑰是生成它的用戶獨(dú)有的代碼。它用于識別對特定 API 的調(diào)用并跟蹤對其的訪問及其使用情況。您可以通過單擊“創(chuàng)建新 API 密鑰”按鈕從加密 API儀表板中生成 API 密鑰。您可以生成多個(gè) API 密鑰并多次使用一個(gè) API 密鑰。
大多數(shù)計(jì)劃都對可進(jìn)行的數(shù)據(jù)調(diào)用數(shù)量以及加密 API 提供的結(jié)果進(jìn)行每日限制或“硬停止”。此限制與您的 API 密鑰使用情況和購買的積分?jǐn)?shù)量直接相關(guān)。您的每日積分將在 UTC 時(shí)間凌晨 0:00 重新加載。
每日信用額度是根據(jù) API 數(shù)據(jù)調(diào)用和密鑰提供的結(jié)果進(jìn)行跟蹤的。每個(gè)學(xué)分均按 1:1 計(jì)算和遞增,但以下情況除外:
這與應(yīng)用于所有加密 API 的 API 調(diào)用速率限制直接相關(guān)。
狀態(tài)碼
代碼類型 | HTTP 狀態(tài)代碼 | 錯(cuò)誤代碼 | 信息 |
---|---|---|---|
客戶端錯(cuò)誤 | 400 | uri_not_found | “未找到指定的 URI。請檢查 URI,然后重試?!?/td> |
limit_greater_than_allowed | “您已達(dá)到允許的限制。此端點(diǎn)的最大項(xiàng)目數(shù)為{limit},請使用特定的分頁屬性來分批獲取項(xiàng)目?!?/td> | ||
invalid_pagination | “已使用的分頁屬性無效。請檢查文檔以查看有關(guān)分頁的詳細(xì)信息?!?/td> | ||
401 | missing_api_key | “缺少特定的授權(quán)標(biāo)頭(API 密鑰),請檢查我們文檔中的授權(quán)部分?!?/td> | |
invalid_api_key | “提供的 API 密鑰無效。請從您的儀表板生成一個(gè)新密鑰?!?/td> | ||
402 | insufficient_credits | “您的積分不足。請從儀表板升級您的計(jì)劃或通過電子郵件聯(lián)系我們的團(tuán)隊(duì)?!?/td> | |
403 | https_required | “需要使用 HTTP S。 ” | |
endpoint_not_allowed_for_plan | “此端點(diǎn)不適用于您當(dāng)前的訂閱計(jì)劃,請升級您的計(jì)劃才能使用它?!?/td> | ||
data_not_allowed_for_plan | “您的訂閱計(jì)劃僅包含 {days} 天的歷史數(shù)據(jù)。請升級您的計(jì)劃或聯(lián)系我們的團(tuán)隊(duì)了解更多信息?!?/td> | ||
banned_ip_address | “該IP地址已被禁止。要檢查原因,請通過電子郵件聯(lián)系我們的團(tuán)隊(duì)。” | ||
endpoint_not_allowed_for_api_key | “此端點(diǎn)不可用于您的 API 密鑰?!?/td> | ||
404 | resource_not_found | “未找到指定的資源?!?/td> | |
405 | request_method_not_supported | “此端點(diǎn)不支持指定的請求方法 ({method})。請檢查我們的文檔并確保設(shè)置正確的請求方法?!?/td> | |
allowed_methods | “指定的方法必須是以下之一:{methods}。” | ||
409 | invalid_query_parameter | “提供的查詢參數(shù)無效。請?zhí)峁┱_的查詢參數(shù),或參閱文檔以獲取更多信息。” | |
missing_request_body | “缺少所需的請求正文,無法執(zhí)行操作?!?/td> | ||
bad_json | “提供的 JSON 無效。請確保其有效,然后重試。” | ||
invalid_data | “提供的數(shù)據(jù)似乎無效。” | ||
already_exists | “指定的資源已經(jīng)存在?!?/td> | ||
callback_url_not_verified | “回調(diào) URL 尚未驗(yàn)證。請?jiān)趦x表板中驗(yàn)證 URL,然后重試。” | ||
missing_required_attributes | “缺少必需的參數(shù)。請?zhí)峁┧斜匦璧膮?shù),或參閱文檔以獲取更多信息?!?/td> | ||
extra_body_attributes | “提供的主體參數(shù)未知或未指定。請僅提供指定的主體參數(shù),或參閱文檔以獲取更多信息。” | ||
extra_query_attributes | “提供的查詢參數(shù)未知或未指定。請僅提供指定的查詢參數(shù),或參閱文檔以獲取更多信息?!?/td> | ||
415 | unsupported_media_type | “所選媒體類型不可用。Content-Type 標(biāo)頭應(yīng)為“application/json”?!?/td> | |
429 | request_limit_reached | “已達(dá)到請求限制。每 {seconds} 秒最多可發(fā)出 {requests} 個(gè)請求。如果您需要更多請求或升級您的套餐,請通過電子郵件聯(lián)系我們的團(tuán)隊(duì)。” | |
服務(wù)器錯(cuò)誤 | 500 | technical_issues | “我們目前遇到一些技術(shù)問題,請稍后重試。” |
unexpected_server_error | “發(fā)生了意外的服務(wù)器錯(cuò)誤,我們正在努力解決此問題。請稍后再試,如果再次發(fā)生,請通過電子郵件向我們的團(tuán)隊(duì)報(bào)告?!?/td> | ||
501 | unimplemented | “此{(lán)feature}尚未實(shí)施。” | |
503 | temporary_shutdown_endpoint | “由于性能原因,此端點(diǎn)暫時(shí)停止。有關(guān)更多信息,請通過電子郵件聯(lián)系我們的團(tuán)隊(duì)?!?/td> |
吞吐量軟限制(6,000 積分/秒)是數(shù)據(jù)處理或傳輸?shù)慕ㄗh閾值。在此限制內(nèi)的使用按每個(gè)積分的基本費(fèi)率計(jì)費(fèi)。吞吐量硬限制(12,000 積分/秒)表示允許的最大吞吐量。超過吞吐量軟限制但仍保持在吞吐量硬限制范圍內(nèi)的使用量將按照略高于基本費(fèi)率的費(fèi)率進(jìn)行計(jì)費(fèi)。超過吞吐量硬限制將導(dǎo)致服務(wù)中斷。超過軟限制的成本處罰 當(dāng)超出吞吐量軟限制但數(shù)據(jù)處理和信用消耗限制仍保持在吞吐量硬限制范圍內(nèi)時(shí),將應(yīng)用成本處罰。成本罰金是根據(jù)您的有效訂閱計(jì)劃通過成本乘數(shù)計(jì)算的。
吞吐量軟限制(6,000 積分/秒)中的示例:如果每秒消耗 100 積分,則該使用量將落入每秒 6,000 積分的軟限制范圍內(nèi)。因此,客戶需要按 100 個(gè)積分的基本費(fèi)率付費(fèi),總共花費(fèi) 100 個(gè)積分。
吞吐量硬限制(12,000 積分/秒)內(nèi)的示例:在每秒使用 8,000 積分的場景中,使用量在吞吐量硬限制范圍內(nèi),但超出了吞吐量軟限制。因此,每個(gè)消耗的積分都會乘以 x1.3 成本懲罰乘數(shù)。因此,8,000 x 1.3 = 10,400 總信貸成本。
訂閱計(jì)劃 | 軟/硬吞吐量限制 | 學(xué)分成本增加 |
---|---|---|
免費(fèi) | 500/500 | 1.0 |
基本 | 3000/6000 | 1.4 |
高級 | 6000/12000 | 1.3 |
專業(yè) | 12000/24000 | 1.2 |
如果您超出上述限制,您的請求將返回 HTTPS 狀態(tài)代碼 429。
在申請和使用 cypto 開放平臺 API密鑰過程中,你可能會遇到以下常見問題:
支持哪些區(qū)塊鏈網(wǎng)絡(luò)?
我們目前支持超過50個(gè)區(qū)塊鏈,包括它們的測試網(wǎng)和主網(wǎng)。關(guān)于支持的網(wǎng)絡(luò)的詳細(xì)信息可在每個(gè)專用服務(wù)網(wǎng)頁上找到。對于某些產(chǎn)品,如“專用節(jié)點(diǎn)即服務(wù)”,我們提供超出列出的區(qū)塊鏈的支持。
是否可以同時(shí)使用多個(gè)Crypto APIs產(chǎn)品?
是的,您可以根據(jù)需要使用我們的服務(wù)。我們的區(qū)塊鏈基礎(chǔ)設(shè)施提供了靈活性,即使您達(dá)到訂閱計(jì)劃限額后,也可以繼續(xù)使用我們。
什么是“吞吐量”?
吞吐量是我們用來衡量每秒可以花費(fèi)的信用數(shù)的指標(biāo)。每個(gè)訂閱計(jì)劃都包括軟性和硬性吞吐量限制。軟性吞吐量表示客戶選擇的訂閱計(jì)劃中包含的每秒請求數(shù)。如果需要,客戶可以超出軟性限制,信用消耗略高于其選擇的訂閱計(jì)劃中指定的數(shù)量。然而,一旦達(dá)到硬性吞吐量限制,客戶將達(dá)到絕對最大允許值。要提高您的硬性吞吐量限制,請升級您的訂閱計(jì)劃或聯(lián)系我們創(chuàng)建一個(gè)滿足您特定需求的自定義計(jì)劃。
每個(gè)端點(diǎn)花費(fèi)多少信用?
您可以在我們的官方文檔中查看每個(gè)端點(diǎn)的信用成本。只需選擇您想要信息的端點(diǎn),信用成本就會顯示在頁面末尾。
在獲得 cypto 開放平臺 API密鑰之后,即可使用平臺提供的各種功能,本文整理了多篇使用 cypto 開放平臺 的案例,幫助讀者更有效的了解cypto 開放平臺 :
錢包即服務(wù)、交易處理、信息查詢、區(qū)塊鏈數(shù)據(jù)、代幣服務(wù)
問題1: 什么是冪簡集成平臺?
冪簡集成是蜜堂有信在2023年打造的一款SAAS產(chǎn)品,建設(shè)著國內(nèi)最全的API平臺,為開發(fā)者提供全面、高效、易用的API集成管理方案,一站搜索、試用、集成國內(nèi)和國外API。讓用戶在AI時(shí)代全方位接入互聯(lián)網(wǎng),用API連接一切服務(wù)和算力,實(shí)現(xiàn)價(jià)值倍增。
問題2:如何找到 cypto 開放平臺
冪簡API平臺可以通過以下兩種方式找到所需API:通過關(guān)鍵詞搜索API(例如,輸入’ cypto 開放平臺 ‘這類品類詞,更容易找到結(jié)果)、或者從API hub分類頁進(jìn)入尋找。
問題3: cypto 開放平臺 的替代品有哪些?
市場上存在免費(fèi)、付費(fèi)兩種替代者
例如
更多競品可以在 cypto 開放平臺 找到。
本文總結(jié)了獲取 Crypto 開放平臺 API 密鑰的詳細(xì)步驟,從注冊平臺賬戶到創(chuàng)建專屬 API 項(xiàng)目,再到生成 API 密鑰,并進(jìn)行了初步的可用性測試。文章還探討了在使用過程中需要考慮的關(guān)鍵因素,如API驗(yàn)證、請求的速率限制、錯(cuò)誤處理等,幫助開發(fā)者更好地集成區(qū)塊鏈數(shù)據(jù)和交易信息到應(yīng)用中,同時(shí)提升應(yīng)用的性能和穩(wěn)定性。