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