API töövoogu juhend

Mida soovite ehitada?

Valige tulemus, mis on teie tööga kõige lähedasem. Iga tee annab teile ühe töökäivituspäringu, sellele, mida vastus peaks sisaldama, kuidas kontrollida, kas see töötas, ja järgmise kasuliku sammu.

Viis praktilist teed

Alustage tulemusega, mitte lõppnukite listiga.

Valitud: Hangi makroandmeid

Sinu 14 päeva API proov

Liiguge esimesest päringust tööle, mis on säilitamist väärt.

Eesmärk ei ole külastada iga tootelehte. Eesmärk on lõpetada kasulik autentitud API töö, naasta teisel päeval ja lahkuda korduvva andmesetiga või rakenduse töövooga.

Kontrollige API ed progresses

Päev 0

Tõesta juurdepääs

Looge võti, täitke üks autentiminega päring ja salvestage esimene vastus koos selle metaandmetega.

Ava samm →

Päevad 1-2

Tee päringest usaldusväärav

Lahendage autentimise või filtreerimise probleemid ja muutke esimene skript nimega korduvaks tööks.

Ava samm →

Päevad 3-4

Lisa väljatuleku ajastus

Kasutage kalendrit kui teist lõppnukite (endpoint) peret ja planeerige järgmine kasulik API käivitus.

Ava samm →

Päevad 5-7

Loo uurimistöö tulemus

Lisage ootused või väike makrotsarjude grupp, seejärel looge üks salvestatud võrdlus, tabel või skoorkaart.

Ava samm →

Päevad 8-10

Automaatne uuendamine

Vali planeeritud REST, SSE või veebikutsed (webhooks) ning soorita teine edukas API käivitus teisel päeval.

Ava samm →

Päevad 11-13

Tugevdage kliendit

Lisage ajavõtmist, piiratud korduste, vastuse validatsioon, autentimisega turvaline logimine ja vanenete andmete jälgimine.

Ava samm →

Päev 14

Vaata tõendeid üle

Kinnita, et API pakub korduvat tööd, mida teie meeskond jätkab, ja vali seejärel järgmine andmeset või rakenduse töövoog.

Ava samm →

Esimene päring

Tõsta ja salvesta makroajalugu

Alusta ühe valuuta ja indikaatoriga, mida sa juba mõistad. See teeb autentimise, vastuse vormi, leheküljestu paginatsiooni ja salvestamise kontrollimise lihtsaks enne uute seeriate lisamist.

10 minutit Alusta siit teated

Töötav näide

Hoidke oma võtme FXMD_API_KEY; ära kopeeri seda kunagi allika kontrolli.

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

Oodatud tulemus: A 200 vastus koos viimaste EUR inflatsioonimõõtmistega ning vastuse metaandmetega, mis kirjeldavad sarja, allikat, lehekülge ja andmete kvaliteeti.

Kui esimene skript muutub reaalne süsteemiks

Veaotsing ja tootmise juhendamine

Kasutage neid juhendeid, kui vastus ebaõnnestub, ei too andmeid või vajab tootlikkuse kontrolli nagu vahemällid (caching), ajavõtuks (timeouts), uuestipüüdmised (retries) ja sündmuste edastamine.

JuhendKasutage seda siis, kuiAlusta
Diagnoseeri ebaõnnestunud või tühi vastus Eraldage autentimise, juurdepääsu, tee, kiiruse piirangu ja andmete kättesaadavuse probleemid ilma oma võtme paljastamata. Ava juhend →
Tee API klient tootmise ettevalmistuseks Lisa ajavõtmised, piiratud kordused, vahemälli, tingimuslikud päringud ja õige kohaletoimetamise muster. Ava juhend →