Diena 0
Patvirtinti prieigą
Sukurkite raktą, atlikite vieną autentikavimą patvirtintą užklausą ir išsaugokite pirmąjį atsakymą su jo metadata.
Atidaryti žingsnį →API darbo eigos vadovas
Ką norite sukurti?
Pasirinkite rezultatą, artimiausią jūsų darbui. Kiekvienas kelias suteikia jums vieną darbinę užklausą, ką turėtų veikti atsakas, kaip patikrinti, ar tai veikė, ir kitą naudingą žingsnį.
Penkios praktinės kryptys
Pradėkite nuo rezultato, o ne nuo galvos ėjus sąrašo.
Selected: Harden a client
Kelias 1
Atsiimti makro duomenis
Gaukite švarų laiko seriją ir kartu su ja išsaugokite šaltinio bei kokybės metadata.
Kelias 2
Planuoti išleidimo darbus
Naudokite išleidimų kalendorių, kad vykdytumėte tikslingus užduotis aplink žinomus paskelbimo laikus.
Kelias 3
Matuoti netiklumus
Pridėkite prieš išleidimo prognozes prie paskelbtos reikšmės nesukeliant ateities žinojimo šališkumo.
Kelias 4
Gauti gyvus atnaujinimus
Naudokite SSE kaip neegzistavimo signalą, tada ištraukite visą įrašą iš REST.
Kelias 5
Sukurti makro modelį
Paverskite nedidelę susijusių rodiklių grupę valiutos rezultatų kortele su šaltinio ženklinimu.
Jūsų 14 dienų API bandymas
Pereikite nuo pirmojo užklausos prie darbo, kurio verta laikytis.
Tikslas nėra lankytis kiekvienoje produkto puslapio. Tikslas yra atlikti naudingą autentikavusį API darbą, sugrįžti kitą dieną ir išeiti su pakartojamu duomenų rinkiniu arba programėlės darbo srautu.
Dienos 1-2
Padarykite užklausą patikimą
Išspręskite autentifikavimo arba filtravimo problemas ir paverskite pirmąjį skriptą pavadinimu pavadinta pakartojama užduotis.
Atidaryti žingsnį →Dienos 3-4
Pridėti išleidimo laiką
Naudokite kalendorių kaip antrąją galvos endpoints šeimą ir suplanuokite kitą naudingą API vykdymą.
Atidaryti žingsnį →Dienos 5-7
Sukurti tyrimo rezultatą
Pridėkite lūkesčius arba nedidelę makro serijų grupę, tada sugeneruokite vieną išliktį paliekančią palyginimą, lentelę arba scorecard'ą.
Atidaryti žingsnį →Dienos 8-10
Automatuokite atnaujinimus
Pasirinkite suplanuotą REST, SSE arba webhook'us ir atlikite kitą sėkmingą API vykdymą kitą dieną.
Atidaryti žingsnį →Dienos 11-13
Sustiprinkite klientą
Pridėkite laiko limitus (timeouts), ribotą kartojimą (bounded retries), atsako validaciją, saugų duomenų įrašymą (credential-safe logging) ir senų duomenų stebėjimą.
Atidaryti žingsnį →Diena 14
Peržiūrėti įrodymus
Patvirtinkite, kad API suteikia pakartojamą darbą, kurį jūsų komanda vykdys, tada pasirinkite kitą duomenų rinktį arba programėlės darbo srautą.
Atidaryti žingsnį →Production readiness
Padarykite API klientą paruoštą gamybai
Production reliability comes from treating status codes differently, keeping retries bounded, reusing ETags, and choosing scheduled REST, SSE, or webhooks for the job.
Veikiantis pavyzdys
Saugokite savo raktą FXMD_API_KEY; niekada neįklijuokite jo į šaltinio kontrolę.
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()Tikėtinas rezultatas: A bounded client that handles transient failures without retry storms and is ready to add ETag-based conditional refreshes.
Kai pirmasis skriptas tampa tikra sistema
Problemų sprendimas ir gamybinės eksploatacijos vadovas
Naudokite šiuos vadovus, jei atsakas nepavyksta, grąžina jokių duomenų arba reikia gamybinių valdymo priemonių, tokių kaip talpinimas, laiko limitai, pakartojimai ir įvykių pristatymas.
| Gidas | Naudokite, kai | Pradėti |
|---|---|---|
| Diagnozuoti nesėkmingą arba tuščią atsakymą | Atskiri autentifikavimo, prieigos, kelio, ribojimo ir duomenų prieinamumo problemos neatskleidžiant jūsų rakto. | Atidžinti vadovą → |
| Padarykite API klientą paruoštą gamybai | Pridėkite laiko apribojimus, ribotus bandymus iš naujo, kelejimą (caching), sąlyginius užklausas ir tinkamą pristatymo modelį. | Atidžinti vadovą → |