API -työnkulkuopas

Mitä haluat rakentaa?

Valitse työllesi lähin lopputulos. Jokainen polku antaa sinulle yhden toimivan pyynnön, tiedon siitä mitä vastauksen tulisi sisältää, ohjeen sen tarkistamiseen ja seuraavan hyödyllisen vaiheen.

Viisi käytännön polkua

Aloita lopputuloksesta, älä päätepistelistasta.

Selected: Plan release jobs

14-päivän API -kokeilujaksosi

Siirry ensimmäisestä pyynnöstä työhön, joka on säilyttämisen arvoinen.

Tavoitteena ei ole vierailla jokaisella tuotesivulla. Tavoitteena on suorittaa hyödyllinen tunnistettu API -työ, palata toisena päivänä ja poistua toistettavan tietoaineiston tai sovellustyönkulun kanssa.

Tarkista API edistyminen

Päivä 0

Todista pääsy

Luo avain, suorita yksi autentikoitu pyyntö ja tallenna ensimmäinen vastaus metadatineen.

Avaa vaihe →

Päivät 1-2

Tee pyynnöstä luotettava

Ratkaise tunnistautumis- tai suodatinongelmat ja muuta ensimmäinen skripti nimettyä toistettavaksi työksi.

Avaa vaihe →

Päivät 3-4

Lisää julkaisuajankohta

Käytä kalenteria toisena päätepisteperheenä ja aikatauluta seuraava hyödyllinen API -ajo.

Avaa vaihe →

Päivät 5-7

Rakenna tutkimustulos

Lisää odotuksia tai pieni ryhmä makrosarjoja, ja luo sitten yksi tallennettu vertailu, taulukko tai pisteytyskortti.

Avaa vaihe →

Päivät 8-10

Automatisoi päivitykset

Valitse ajastettu REST, SSE tai webhooks ja suorita toinen onnistunut API -ajo eri päivänä.

Avaa vaihe →

Päivät 11-13

Vahvista asiakasohjelma

Lisää aikakatkaisut, rajatut uudelleenyritykset, vastauksen validointi, tunnusturvallinen lokitus ja vanhentuneen datan seuranta.

Avaa vaihe →

Päivä 14

Tarkista todisteet

Varmista, että API tarjoaa toistettavan työn, jonka tiimisi säilyttää, ja valitse sitten seuraava tietoaineisto tai sovelluksen työnkulku.

Avaa vaihe →

Scheduled workflow

Plan around confirmed releases

The calendar tells your scheduler when a release is expected. Your job can then fetch the full announcement record after publication instead of polling every series continuously.

15 minutes Core workflow kalenteriilmoitukset

Toimiva esimerkki

Pidä avaimesi FXMD_API_KEY; älä koskaan liitä sitä versionhallintaan.

from datetime import date, timedelta
import os
import requests

events = requests.get(
    "https://api.fxmacrodata.com/v1/calendar/eur",
    params={
        "api_key": os.environ["FXMD_API_KEY"],
        "start_date": date.today().isoformat(),
        "end_date": (date.today() + timedelta(days=14)).isoformat(),
        "timezone": "UTC",
    },
    timeout=20,
).json()["data"]
print(events[:3])

Odotettu tulos: Upcoming EUR releases with dates, times, indicator paths, and confirmation fields that your scheduler can evaluate before creating a job.

Kun ensimmäisestä skriptistä tulee oikea järjestelmä

Vianetsintä ja tuotanto-ohjeistus

Käytä näitä oppaita, kun vastaus epäonnistuu, ei palauta tietoja tai vaatii tuotantokontrolleja, kuten välimuistia, aikakatkaisuja, uudelleenyrityksiä ja tapahtumien toimitusta.

OpasKäytä sitä, kunAloita
Diagnosoi epäonnistunut tai tyhjä vastaus Erota tunnistautumis-, pääsy-, polku-, nopeusrajoitus- ja tietojen saatavuusongelmat paljastamatta avaintasi. Avaa opas →
Tee API -asiakkaasta tuotantovalmis Lisää aikakatkaisut, rajatut uudelleenyritykset, välimuisti, ehdolliset pyynnöt ja oikea toimitusmalli. Avaa opas →