API 工作流程指南

您想要構建什麼?

選擇最接近您工作的結果。每條路徑會提供一個可運行的請求、回應應包含的內容、如何檢查是否成功以及下一個有用步驟。

五條實用路徑

從結果開始,而不是從端點列表開始。

已選擇:獲取宏觀數據

您的 14 天 API 試用

從第一次請求轉變為一份值得保留的工作。

目標不是訪問每個產品頁面。而是完成有用的經過身份驗證的 API 工作,在另一天返回,並帶著可重複的數據集或應用程序工作流離開。

檢查 API 進度

第 0 天

證明權限

創建金鑰,完成一次經過身份驗證的請求,並保存首次響應及其元數據。

開啟步驟 →

天數 1-2

使請求可靠

解決身份驗證或篩選問題,並將第一個腳本轉化為具名的可重複作業。

開啟步驟 →

第 3-4 天

添加發佈時間

將日曆用作第二個端點系列,並排定下一次有用的 API 執行時間。

開啟步驟 →

天數 5-7

構建研究輸出

添加預期或一小組宏觀系列,然後生成一個保存的比較、表格或計分卡。

開啟步驟 →

天數 8-10

自動化更新

選擇排定的 REST、SSE 或 webhooks,並在不同日期完成另一次成功的 API 運行。

開啟步驟 →

天數 11-13

強化客戶端

添加超時、有界重試、回應驗證、憑據安全日誌記錄和陳舊數據監控。

開啟步驟 →

天 14

審查證據

確認 API 提供了一個您的團隊將保留的可重複工作,然後選擇下一個數據集或應用工作流。

開啟步驟 →

首次請求

獲取並保存宏觀歷史數據

從您已經熟悉的單一貨幣和指標開始。這使得在添加更多序列之前,可以輕鬆驗證身份驗證、回應格式、分頁和儲存。

10 分鐘 從這裡開始 公告

運行示例

將您的金鑰保留在 FXMD_API_KEY; 絕不要將其貼入源控制系統。

import os
import requests

response = requests.get(
    "https://api.fxmacrodata.com/v1/announcements/eur/inflation",
    params={"api_key": os.environ["FXMD_API_KEY"], "limit": 5},
    timeout=20,
)
response.raise_for_status()
payload = response.json()
print(payload["data"][0])

預期結果: 一個 200 響應,包含最近的 EUR 通貨膨脹觀測值,以及描述系列、來源、分頁和數據質量的響應元數據。

當第一個腳本變成一個真實系統時

故障排除與生產環境指南

當響應失敗、未返回數據或需要生產控制(如緩存、超時、重試和事件交付)時,請使用這些指南。

指南在以下情況使用開始
診斷失敗或空的響應 在不暴露金鑰的情況下,分離身份驗證、訪問、路徑、速率限制和數據可用性問題。 開啟指南 →
使 API 客戶端達到生產就緒狀態 添加超時、有界重試、緩存、條件請求和正確的交付模式。 開啟指南 →