vodič za delovni proces API

Kaj želite zgraditi?

Izberite rezultat, ki je najbližji vašemu delu. Vsaka pot vam nudi eno delujočo zahtevo, vsebino odgovora, način preverjanja delovanja in naslednji korak.

Pet praktičnih poti

Začnite s rezultatom, ne s seznamom končališč.

Selected: Harden a client

Vaše API brezplačno preizkusno obdobje za 14 dni

Prehod od prvega zahtevka do opravila, ki se splača.

Cilj ni obiskovanje vsake strani izdelka. Cilj je opraviti uporabne avtentikirane API naloge, se vrniti drugega dne in oditi z ponovljivim naborom podatkov ali delovnim procesom aplikacije.

Preverite napredek API

Dan 0

Dokazati dostop

Ustvarite ključ, izvedite en avtoriziran zahtev, in shranite prvi odgovor z njegovimi metapodatki.

Odpri korak →

Dni 1-2

Naredite zahtevo zanesljivo

Rešite težave z avtentikacijo ali filtri in prvi skript spremenite v poimenjeno ponovljivo nalogo.

Odpri korak →

Dni 3-4

Dodaj čas objave

Uporabite koledar kot drugo družino končališč in načrtujte naslednji uporaben API ciklus.

Odpri korak →

Dni 5-7

Zgradite raziskovalni izhod

Dodajte pričakovanja ali majhno skupino makro serij, nato pa izdelajte eno shranjeno primerjavo, tabelo ali tabelo rezultatov.

Odpri korak →

Dnevi 8-10

Avtomatizirajte posodobitve

Izberite načrtovane REST, SSE ali spletne klicaje (webhooks) in zaključite drugo uspešno izvedbo API na drug dan.

Odpri korak →

Dni 11-13

Okrepite klijenta

Dodajte časovne omejitve, omejene ponovne poskuse, validacijo odgovora, varno beleženje podatkov in spremljanje zastarelih podatkov.

Odpri korak →

Dan 14

Preglej dokaze

Potrdite, da API zagotavlja ponovljivo opravilo, ki ga bo vaša ekipa izvajala, nato pa izberite naslednji nabor podatkov ali delovni proces aplikacije.

Odpri korak →

Production readiness

Naredite API klijenta pripravljenega na produkcijo

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 objavechangesstreamwebhooks

Delujoč primer

Svoj ključ shranite v FXMD_API_KEY; nikoli ga ne prilepite v nadzor nad viri.

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

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

Ko prvi skript postane pravi sistem

Reševanje težav in vodstvo za produkcijo

Uporabite te priročnike, ko odgovor ne uspe, ne vrne podatkov ali zahteva produkcijskih nadzornih funkcij, kot so predpomnjeno shranjevanje, časovni izlivi, ponovni poskusi in dostava dogodkov.

NavodiloUporabite, koZačni
Diagnosticirajte neuspešen ali prazen odgovor Ločite težave z avtentikacijo, dostopom, potjo, omejitvijo hitrosti in razpoložljivostjo podatkov, ne da bi razkrili svoj ključ. Odpri vodnik →
Naredite API klijenta pripravljenega na produkcijo Dodajte časovne omejitve, omejene ponovni poskuse, predpomnjeno, pogojne zahteve in ustrezen vzorec dostave. Odpri vodnik →