Diena 0
Pierādīt piekļuvi
Izveidojiet atslēgu, izveidojiet vienu autentificētu pieprasījumu un saglabājiet pirmo atbildi ar tās metadatiem.
Atvērt soli →API darba plūsmas rokasgrāmata
Izvēlieties iznākumu, kas visvairāk atbilst jūsu uzdevumam. Katrs ceļš sniedz vienu darbojošos pieprasījumu, informāciju par to, ko atbildzei jāsatur, kā pārbaudīt darbību un nākamo noderīgo soli.
Pieci praktiski ceļi
Selected: Harden a client
Jūsu 14 dienu API izmēģinājums
Mērķis nav apmeklēt katru produkta lapu. Tas ir pabeigt noderīgu autentificētu API darbu, atgriezties citā dienā un aiziet ar atkārtojamu datu kopu vai lietotnes darba procesu.
Diena 0
Izveidojiet atslēgu, izveidojiet vienu autentificētu pieprasījumu un saglabājiet pirmo atbildi ar tās metadatiem.
Atvērt soli →Dienas 1-2
Atrisiniet autentifikācijas vai filtra problēmas un pārvērtiet pirmo skriptu par benējamu, nosauktu uzdevumu.
Atvērt soli →Dienas 3-4
Izmantojiet kalendāru kā otru gala punktu saime un ieplānojiet nākamo noderīgo API palešanu.
Atvērt soli →Dienas 5-7
Pievienojiet cerības vai mazu makro sēriju grupu, pēc tam izveidojiet vienu saglabātu salīdzinājumu, tabulu vai rezultātu lapu.
Atvērt soli →Dienas 8-10
Izvēlieties plānotu REST, SSE vai webhooks un veiciet vēl vienu veiksmīgu API izpildi citā dienā.
Atvērt soli →Dienas 11-13
Pievienojiet taimautus, ierobežotus atkārtojumus, atbildes validēšanu, drošu kredenciālu žurnālveidu un novecojušo datu uzraudzību.
Atvērt soli →Diena 14
Apstipriniet, ka API nodrošina atkārtojamu darbu, ko jūsu komanda saglabās, pēc tam izvēlieties nākamo datu kopumu vai lietošanas darba plūsmu.
Atvērt soli →Production readiness
Production reliability comes from treating status codes differently, keeping retries bounded, reusing ETags, and choosing scheduled REST, SSE, or webhooks for the job.
Darbojošs piemērs
Sagatavojiet savu atslēgu FXMD_API_KEY; nekad neielīmējiet to avotkontrolē.
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()
Gaidītais rezultāts: A bounded client that handles transient failures without retry storms and is ready to add ETag-based conditional refreshes.
Kad pirmais skripts kļūst par īstu sistēmu
Izmantojiet šos ceļvežu, ja atbildze neveiksmīga, neatgriež datus vai nepieciešama ražošanas kontrole, piemēram, kešēšana, taimauti, atkārtojumi un notikumu piegāde.
| Rokasgrāmata | Izmantojiet to, kad | Sākt |
|---|---|---|
| Diagnosticēt neveiksmīgu vai tukšu atbildi | Atsevišķi risiniet autentifikācijas, piekļuves, ceļa, ātruma ierobežojumu un datu pieejamības problēmas, neatklājot savu atslēgu. | Atvērt rokasgrāmatu → |
| Padarīt API klientu gatavu produkcijai | Pievienot taimautus, ierobežotus atkārtojumus, kešēšanu, kondicionālos pieprasījumus un pareizo piegādes shēmu. | Atvērt rokasgrāmatu → |