průvodce pracovním postupem API

Co chcete vybudovat?

Vyberte výsledek, který nejvíce odpovídá vašemu úkolu. Každá cesta vám poskytne jeden funkční požadavek, informaci o tom, co by měla odpověď obsahovat, jak ověřit funkčnost a další užitečný krok.

Pět praktických cest

Začněte s výsledkem, nikoli se seznamem endpointů.

Selected: Harden a client

Vaše 14-denní API zkušební verze

Posuňte se od prvního požadavku k práci, za kterou stojí stát.

Cílem není navštívit každou stránku produktu. Cílem je dokončit užitečnou autentizovanou API práci, vrátit se jiný den a odejít s opakovatelnou sadou dat nebo pracovním postupem aplikace.

Zkontrolovat pokrok API

Den 0

Prokázat přístup

Vytvořte klíč, proveďte jeden autentizovaný požadavek a uložte první odpověď s jejími metadaty.

Otevřít krok →

Dny 1-2

Učinit požadavek spolehlivým

Vyřešte problémy s autentizací nebo filtry a převeďte první skript na pojmenovanou opakovatelnou úlohu.

Otevřít krok →

Dny 3-4

Přidat načasování releasu

Použijte kalendář jako druhou rodinu endpointů a naplánujte další užitečný běh API.

Otevřít krok →

Dny 5-7

Vytvořit výstup výzkumu

Přidejte očekávání nebo malou skupinu makro sérií a poté vygenerujte jedno uložené srovnání, tabulku nebo scorecard.

Otevřít krok →

Dny 8-10

Automatizujte aktualizace

Vyberte naplánované REST, SSE nebo webhooky a dokončete další úspěšný běh API v jiný den.

Otevřít krok →

Dny 11-13

Zpevněte klienta

Přidejte časové limity, omezené počety pokusů, validaci odpovědí, bezpečné logování přihlašovacích údajů a monitoring zastaralých dat.

Otevřít krok →

Den 14

Zkontrolovat důkazy

Potvrďte, že API poskytuje opakovatelnou práci, kterou váš tým udrží, a poté vyberte další sadu dat nebo pracovní postup aplikace.

Otevřít krok →

Production readiness

Připravte API klienta pro produkci

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 oznámeníchangesstreamwebhooks

Fungující příklad

Uchovejte svůj klíč v FXMD_API_KEY; nikdy jej nevkládejte do řízení zdrojového kódu.

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()

Očekávaný výsledek: A bounded client that handles transient failures without retry storms and is ready to add ETag-based conditional refreshes.

Když se první skript stane skutečným systémem

Řešení problémů a produkční doporučení

Používejte tyto průvody, když odpověď selže, nevrátí žádná data nebo vyžaduje produkční ovládací prvky, jako je cachování, časové limity, opakování a doručování událostí.

PrůvodcePoužijte jej, kdyžStart
Diagnostika selhané nebo prázdné odpovědi Oddělte problémy s autentizací, přístupem, cestou, limitováním rychlosti a dostupností dat, aniž byste odhalili svůj klíč. Otevřít průvodce →
Připravte API klienta pro produkci Přidejte časové limity, omezené počety pokusů, cachování, podmíněné požadavky a správný vzorec doručení. Otevřít průvodce →