príručka k workflow API

Čo chcete vybudovať?

Vyberte výsledok najbližší vašej práci. Každá cesta vám poskytne jeden funkčný request, informáciu o tom, čo by mala odpoveď obsahovať, ako skontrolovať, či fungovala, a ďalší užitočný krok.

Päť praktických ciest

Začnite s výsledkom, nie so zoznamom endpointov.

Vybrané: Získať makro dáta

Vaša 14-dňová API skúška

Prejdite od prvého requestu k práci, za ktorú stojí stáť.

Cieľom nie je navštíviť každú stránku produktu. Cieľom je dokončiť užitočnú autentifikovanú API prácu, vrátiť sa v ďalší deň a odísť s opakovateľnou sadou dát alebo pracovným postupom aplikácie.

Kontrolovať pokrok API

Deň 0

Dokázať prístup

Vytvorte kľúč, dokončite jeden autentifikovaný request a uložte prvú odpoveď s jej metadata.

Otvoriť krok →

Dni 1-2

Urobte request spoľahlivým

Vyriešte problémy s autentifikáciou alebo filtrom a premeňte prvý skript na pomenovanú opakovateľnú úlohu.

Otvoriť krok →

Dni 3-4

Pridať načasovanie vydania

Použite kalendár ako druhú rodinu endpointov a naplánujte ďalší užitočný beh API.

Otvoriť krok →

Dni 5-7

Vytvoriť výstup výskumu

Pridajte očakávania alebo malú skupinu makro sérií a následne vytvorte jedno uložené porovnanie, tabuľku alebo výsledkovú tabuľku.

Otvoriť krok →

Dni 8-10

Automatizujte aktualizácie

Vyberte naplánované REST, SSE alebo webhooky a dokončite ďalší úspešný beh API v iný deň.

Otvoriť krok →

Dni 11-13

Zosilnite klienta

Pridajte timeouty, obmedzené pokusy o opakovanie, validáciu odpovedí, bezpečné logovanie prístupových údajov a monitorovanie zastaraných dát.

Otvoriť krok →

Deň 14

Preskúmať dôkazy

Potvrďte, že API poskytuje opakovateľnú prácu, ktorú váš tím ponechá, potom vyberte ďalšiu sadu dát alebo pracovný postup aplikácie.

Otvoriť krok →

Prvý request

Načítajte a uložte makro históriu

Začnite s jednou menou a indikátorom, ktoré už poznáte. To uľahčí overenie autentifikácie, tvaru odpovede, paginácie a úložiska predtým, než pridáte ďalšie série.

10 minút Začnite tu oznámenia

Fungujúci príklad

Uchovajte svoj kľúč v FXMD_API_KEY; nikdy ho nevkladajte do zdrojovej kontroly.

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

Očakávaný výsledok: Odpoveď 200 s nedávnymi pozorovaniami inflácie EUR plus metadata odpovede popisujúce sériu, zdroj, pagináciu a kvalitu údajov.

Keď sa prvý skript stane reálnym systémom

Riešenie problémov a produkčné smernice

Používajte tieto príručky, keď odpoveď zlyhá, nevracia žiadne dáta alebo vyžaduje produkčné kontroly, ako sú cache, timeouty, opakovania a doručovanie udalostí.

PríručkaPoužite to, keďŠtart
Diagnostikujte zlyhanú alebo prázdnu odpoveď Oddielte problémy s autentifikáciou, prístupom, cestou, limitom rýchlosti a dostupnosťou dát bez odhalenia vášho kľúča. Otvormu sprievodca →
Urobte API klienta pripraveným na produkciu Pridajte timeouty, obmedzené pokusy o opakovanie, cachovanie, podmienené požiadavky a správny vzor doručenia. Otvormu sprievodca →