コンテンツへスキップ

API ワークフローガイド

何を作成したいですか?

あなたの業務に最も近い結果を選択してください。各パスには、1つの実行可能なリクエスト、レスポンスに含めるべき内容、動作確認方法、および次の有用なステップが示されています。

5つの実用的なパス

エンドポイントのリストではなく、結果から始めてください。

Selected: Harden a client

あなたの 14 日間 API トライアル

最初のリクエストから、価値のあるジョブへと移行しましょう。

目標は、すべての製品ページを訪問することではありません。有用な認証済み API 作業を完了し、別の日に戻ってきて、再現可能なデータセットまたはアプリケーションワークフローを持って去ることです。

API の進捗を確認

日 0

アクセスを証明

キーを作成し、認証済みリクエストを1回完了させ、最初のレスポンスをそのメタデータと共に保存してください。

ステップを開く →

日数 1-2

リクエストを信頼できるものにする

認証またはフィルターの問題を解決し、最初のスクリプトを名前付きの繰り返し可能なジョブに変換します。

ステップを開く →

日 3-4

リリース時期を追加

カレンダーを第2のエンドポイントファミリーとして使用し、次に有用な API 実行をスケジュールします。

ステップを開く →

日数 5-7

リサーチ出力を構築

期待値または少数のマクロシリーズを追加し、保存された比較、テーブル、またはスコアカードを1つ作成します。

ステップを開く →

日数 8-10

更新を自動化

スケジュールされた REST、SSE、または Webhook を選択し、別の日に別の API 実行を成功させてください。

ステップを開く →

日数 11-13

クライアントを強化する

タイムアウト、制限付きリトライ、レスポンス検証、認証情報に安全なロギング、および古いデータのモニタリングを追加します。

ステップを開く →

日 14

エビデンスを確認

API がチームが継続して利用する反復可能なジョブを提供することを確認してから、次のデータセットまたはアプリケーションワークフローを選択してください。

ステップを開く →

Production readiness

API クライアントをプロダクション対応にする

Production reliability comes from treating status codes differently, keeping retries bounded, reusing ETags, and choosing scheduled REST, SSE, or webhooks for the job.

25 minutes Production pattern 発表changesstreamwebhooks

動作例

キーを以下に保持 FXMD_API_KEY; ソース管理には決して貼り付けないでください。

import os
import requests
from urllib3.util.retry import Retry

session = requests.Session()
retry = Retry(total=3, backoff_factor=0.5, status_forcelist=(429, 502, 503, 504))
session.mount("https://", requests.adapters.HTTPAdapter(max_retries=retry))

response = session.get(
    "https://api.fxmacrodata.com/v1/announcements/eur/inflation",
    params={"api_key": os.environ["FXMD_API_KEY"], "limit": 5},
    headers={"Accept-Encoding": "gzip"},
    timeout=(3.05, 20),
)
response.raise_for_status()

期待される結果: A bounded client that handles transient failures without retry storms and is ready to add ETag-based conditional refreshes.

最初のスクリプトが本物のシステムになるとき

トラブルシューティングおよび本番環境向けガイダンス

レスポンスの失敗、データの未返却、またはキャッシュ、タイムアウト、リトライ、イベント配信などの本番環境用コントロールが必要な場合は、これらのガイドを使用してください。

ガイド使用する場合開始
失敗した、または空のレスポンスの診断 キーを公開することなく、認証、アクセス、パス、レート制限、およびデータ可用性の問題を分離します。 ガイドを開く →
API クライアントをプロダクション対応にする タイムアウト、制限付きリトライ、キャッシュ、条件付きリクエスト、および適切な配信パターンを追加します。 ガイドを開く →