API vodič za radni tok

Šta želite izgraditi?

Odaberite ishod najbliži vašem poslu. Svaki put vam daje jedan radni zahtjev, šta odgovor treba sadržati, kako provjeriti da li je uspjelo i sljedeći koristan korak.

Pet praktičnih putanja

Počnite s ishodom, a ne s listom endpointa.

Selected: Harden a client

Vaš 14-dnevni API probni period

Krenite od prvog zahtjeva do posla vrijednog zadržavanja.

Cilj nije posjetiti svaku stranicu proizvoda. Cilj je završiti koristan autentificirani API posao, vratiti se drugog dana i otići s ponovljivim setom podataka ili radnim tokom aplikacije.

Provjerite API napredak

Dan 0

Dokažite pristup

Kreirajte ključ, izvršite jedan autentifikovani zahtjev i sačuvajte prvi odgovor sa njegovim metapodacima.

Otvori korak →

Dani 1-2

Učinite zahtjev pouzdanim

Riješite probleme s autentifikacijom ili filtriranjem i pretvorite prvi skript u imenovani ponovljivi posao.

Otvori korak →

Dani 3-4

Dodaj vrijeme objave

Koristite kalendar kao drugu porodicu endpointa i zakažite sljedeće korisno API pokretanje.

Otvori korak →

Dani 5-7

Izgradite istraživački izlaz

Dodajte očekivanja ili malu grupu makro serija, zatim kreirajte jedno sačuvano poređenje, tabelu ili scorecard.

Otvori korak →

Dani 8-10

Automatizujte ažuriranja

Odaberite zakazani REST, SSE ili webhook-ove i završite još jedno uspješno API pokretanje drugog dana.

Otvori korak →

Dani 11-13

Ojačajte klijenta

Dodajte timeout-ove, ograničene pokušaje ponovnog slanja, validaciju odgovora, sigurno logovanje kredencijala i praćenje zastarjelih podataka.

Otvori korak →

Dan 14

Pregledajte dokaze

Potvrdite da API obezbjeđuje ponovljiv posao koji će vaš tim zadržati, zatim odaberite sljedeći set podataka ili radni tok aplikacije.

Otvori korak →

Production readiness

Učinite API klijenta spremnim za produkciju

Production reliability comes from treating status codes differently, keeping retries bounded, reusing ETags, and choosing scheduled REST, SSE, or webhooks for the job.

25 minutes Production pattern najavechangesstreamwebhooks

Radni primjer

Čuvajte svoj ključ u FXMD_API_KEY; nikada ga ne lijepite u kontrolu izvora.

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

Očekivani rezultat: A bounded client that handles transient failures without retry storms and is ready to add ETag-based conditional refreshes.

Kada prva skripta postane pravi sistem

Rješavanje problema i smjernice za produkciju

Koristite ove vodiče kada odgovor ne uspije, ne vrati podatke ili zahtijeva proizvodne kontrole kao što su keširanje, timeout-i, ponovni pokušaji i isporuka događaja.

VodičKoristite ga kadaStart
Dijagnostikuj neuspjeli ili prazan odgovor Odvojite probleme s autentifikacijom, pristupom, putanjom, ograničenjem brzine i dostupnošću podataka bez otkrivanja svog ključa. Otvori vodič →
Učinite API klijenta spremnim za produkciju Dodaj timeout-e, ograničene pokušaje ponovnog slanja, keširanje, kondicionalne zahtjeve i ispravan obrazac isporuke. Otvori vodič →