vodič za API radni proces

Što želite izgraditi?

Odaberite ishod najbliži vašem poslu. Svaka staza daje vam jedan funkcionalni zahtjev, što odgovor treba sadržavati, kako provjeriti je li uspio i sljedeći koristan korak.

Pet praktičnih putova

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

Odabrano: Dohvati makro podatke

Vaše 14-dnevno API probno razdoblje

Pređite s prvog zahtjeva na posao vrijedan održavanja.

Cilj nije posjetiti svaku stranicu proizvoda. Cilj je dovršiti koristan autentificirani API rad, vratiti se drugog dana i otići s ponovljivim skupom podataka ili radnim tijekom aplikacije.

Provjerite API napredak

Dan 0

Dokazati pristup

Kreirajte ključ, izvršite jedan autentificirani zahtjev i spremite prvi odgovor s njegovim metapodacima.

Otvori korak →

Dana 1-2

Učinite zahtjev pouzdanim

Riješite probleme s autentifikacijom ili filtriranjem i pretvorite prvi skript u nazvani ponavljajući posao.

Otvori korak →

Dani 3-4

Dodaj vrijeme objave

Koristite kalendar kao drugu obitelj endpointa i zakružite sljedeće korisno API pokretanje.

Otvori korak →

Dana 5-7

Izgradite istraživački ishod

Dodajte očekivanja ili malu grupu makro serija, a zatim generirajte jednu spremljenu usporedbu, tablicu ili scorecard.

Otvori korak →

Dana 8-10

Automatizirajte ažuriranja

Odaberite zakazane REST, SSE ili webhookove i dovršite još jedan uspješan API ciklus drugog dana.

Otvori korak →

Dana 11-13

Ojačajte klijenta

Dodajte timeoutove, ograničene ponovne pokušaje, validaciju odgovora, sigurno logiranje vjerodajnica i praćenje zastarjelih podataka.

Otvori korak →

Dan 14

Pregledajte dokaze

Potvrdite da API osigurava ponovljiv posao koji će vaš tim održavati, a zatim odaberite sljedeći skup podataka ili radni proces aplikacije.

Otvori korak →

Prvi zahtjev

Dohvati i spremi makro povijest

Počnite s jednom valutom i indikatorom koji već razumijete. To olakšava provjeru autentifikacije, oblika odgovora, paginacije i pohrane prije nego što dodate više serija.

10 minuta Počnite ovdje objave

Radni primjer

Držite svoj ključ u FXMD_API_KEY; nikada ga ne zalijepljite u kontrolu izvora.

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

Očekivani rezultat: A 200 odgovor s nedavnim EUR promatranjima inflacije uz metapodatke odgovora koji opisuju seriju, izvor, paginaciju i kvalitetu podataka.

Kada prvi skript postane stvarni sustav

Rješavanje problema i smjernice za produkciju

Koristite ove vodiče kada odgovor ne uspije, ne vraća podatke ili zahtijeva produkcijske kontrole kao što su predmemorija, timeouti, ponovni pokušaji i isporuka događaja.

VodičKoristite ga kadaZapočni
Dijagnosticirajte neuspjeli ili prazan odgovor Razdvojite probleme s autentifikacijom, pristupom, putanjom, ograničenjem brzine i dostupnošću podataka bez izlaganja vašeg ključa. Otvori vodič →
Učinite API klijenta spremnim za produkciju Dodajte timeoutove, ograničene ponovljene pokušaje, cacheiranje, uvjetne zahtjeve i ispravan obrazac isporuke. Otvori vodič →