API munkafolyamat útmutató

Mit szeretne építeni?

Válassza azt az eredményt, amely a legközelebb áll a feladatához. Minden útvonal egy működő kérést, azt, hogy mit kell tartalmaznia a válasznak, hogyan ellenőrizhető a működése, valamint a következő hasznos lépést adja meg.

Öt gyakorlati út

Kezdje az eredménnyel, ne a végpontlistával.

Kiválasztva: Makro adatok lekérése

Az Ön 14 napos API próbaidőszaka

Lépjen az első kéréstől egy megtartásra méltó munkakörhöz.

A cél nem minden termékoldal meglátogatása. A cél a hasznos, hitelesített API munka befejezése, a visszatérés egy másik napon, és egy ismételhető adatkezlet vagy alkalmazási munkafolyamat elérése.

Ellenőrizze a API haladást

Nap 0

Hozzáférés igazolása

Készítse el a kulcsot, végezzen egy hitelesített kérést, és mentse el az első választ a metaadataival együtt.

Lépés megnyitása →

Napok 1-2

Tegye a kérést megbízhatóvá

Oldja meg a hitelesítési vagy szűrési problémákat, és alakítsa az első szkriptet egy nevezett, ismételhető feladattá.

Lépés megnyitása →

Napok 3-4

Kiadási időpont hozzáadása

Használja a naptárat második végpontcsaládként, és ütemezze a következő hasznos API futtatást.

Lépés megnyitása →

Napok 5-7

Építse fel a kutatási eredményt

Adjon hozzá elvárásokat vagy egy kis csoportot makro-sorokból, majd hozzon létre egy mentett összehasonlítást, táblázatot vagy pontszámtáblázatot.

Lépés megnyitása →

Napok 8-10

Automatizálja a frissítéseket

Válasszon ütemezett REST, SSE vagy webhook-okat, és hajtson végre egy másik sikeres API futtatást egy másik napon.

Lépés megnyitása →

Napok 11-13

Erősítse a klienst

Adjon hozzá időkitürelmeket, korlátozott újrapróbálásokat, válaszellenőrzést, hitelesítési adatokat megőrző naplózást és elavult adatfigyelést.

Lépés megnyitása →

Nap 14

Bizonyítékok áttekintése

Győződjön meg róla, hogy a API egy megismételhető feladatot biztosít, amelyet a csapata megtart, majd válassza a következő adattészletet vagy alkalmazási munkafolyamatot.

Lépés megnyitása →

Első kérés

Makro történet lekérése és mentése

Kezdje egy olyan pénznemmel és indikátorral, amelyet már ismer. Ez megkönnyíti az autentikáció, a válasz szerkezetének, a pagináció és a tárolás ellenőrzését, mielőtt további sorozatokat hozzáadna.

10 perc Kezdje itt bejelentések

Működő példa

Tartsa a kulcsát a FXMD_API_KEY; soha ne illessze be forráskontrollba.

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

Várった eredmény: Egy 200 válasz a legutóbbi EUR inflációs megfigyelésekkel, valamint a sorozatot, a forrást, az oldalozást és az adatminőséget leíró válasz metaadatokkal.

Amikor az első szkript valódi rendszerre válik

Hibaelhárítás és produkciós útmutató

Használja ezeket az útmutatókat, ha egy válasz hibázik, nem ad vissza adatot, vagy olyan produkciós vezérlésekre van szükség, mint a gyorsításementegesítés, időtúllépések, újrapróbálások és eseménykézbesítés.

ÚtmutatóHasználja, amikorKezdés
Sikertelen vagy üres válasz diagnosztizálása Szegregálja a hitelesítési, hozzáférési, útvonali, sebességi korlátozás és adat-elérhetőségi problémákat anélkül, hogy felfedné a kulcsát. Útmutató megnyitása →
Tegye egy API klienst produkciós készre Adjon hozzá időkitürelmet, korlátozott újrapróbálást, gyorsítást, feltételes kéréseket és a megfelelő kézbesítési mintát. Útmutató megnyitása →