Mwongozo wa mtiririko wa kazi wa API

Unataka kujenga nini?

Chagua matokeo yanayokaribiana na kazi yako. Kila njia inakupa ombi moja la kazi, kile ambacho jibu linapaswa kuwa nacho, jinsi ya kuangalia kama ilifanya kazi, na hatua inayofuata muhimu.

Chagua mtiririko wa kazi Fungua Usimamizi wa API

Njia tano za kivitendo

Anza na matokeo, si orodha ya endpoint.

Selected: Harden a client

Njia 1 Pata data za macro Pata mfululizo wa muda safi na uweke metadata ya chanzo na ubora kando yake. Njia 2 Panga kazi za matoleo Tumia kalenda ya utoaji kuendesha kazi maalum karibu na nyakati zinazojulikana za uchapishaji. Njia 3 Pima mshangao Unganisha utabiri wa kabla ya utoaji kwenye thamani iliyochapishwa bila kuleta upendeleo wa kuona mbeleni (lookahead bias). Njia 4 Pokea sasisho za moja kwa moja Tumia SSE kama ishara ya kutofanya kazi, kisha pata rekodi kamili kutoka REST. Njia 5 Jenga modeli ya macro Geuza kikundi kidogo cha viashiria vinavyohusiana kuwa kadi ya alama ya sarafu iliyowekwa lebo ya chanzo.

Jaribio lako la API la siku 14

Hama kutoka ombi la kwanza hadi kazi inayostahili kuendelezwa.

Lengo si kutembelea kila ukurasa wa bidhaa. Ni kukamilisha kazi muhimu ya API iliyothibitishwa, kurudi siku nyingine, na kuondoka na seti ya data inayojirudia au mfumo wa kazi wa programu.

Angalia maendeleo ya API

Siku 0

Thibitisha upatikanaji

Tengeneza ufunguo, kamilisha ombi moja lililothibitishwa, na hifadhi jibu la kwanza pamoja na metadata yake.

Fungua hatua →

Siku 1-2

Fanya ombi liwe la kuaminika

Tatua matatizo ya uthibitishaji au vichujio na ubadilishe script ya kwanza kuwa kazi inayojirudia yenye jina.

Fungua hatua →

Siku 3-4

Ongeza muda wa utoaji

Tumia kalenda kama familia ya endpoint ya pili na upange utendaji ujao wa API unaofaa.

Fungua hatua →

Siku 5-7

Jenga matokeo ya utafiti

Ongeza matarajio au kikundi kidogo cha mfululizo wa macro, kisha utengeneze ulinganisho mmoja uliohifadhiwa, jedwali, au kadi ya alama.

Fungua hatua →

Siku 8-10

Otomatisha sasisho

Chagua REST, SSE, au webhooks zilizopangwa na ukamilishe mwingine wa API wenye mafanikio siku tofauti.

Fungua hatua →

Siku 11-13

Imarisha mteja

Ongeza muda wa kusubiri (timeouts), majaribio yenye mipaka, uhakiki wa jibu, uandishi wa kumbukumbu salama wa utambulisho, na ufuatiliaji wa data iliyopitwa na wakati.

Fungua hatua →

Siku ya 14

Kagua ushahidi

Thibitisha kwamba API inatoa kazi inayoweza kurudiwa ambayo timu yako itaendeleza, kisha chagua seti inayofuata ya data au mchakato wa programu.

Fungua hatua →

Production readiness

Fanya mteja wa API awe tayari kwa uzalishaji

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 matangazochangesstreamwebhooks

Mfano unaofanya kazi

Weka funguo yako katika FXMD_API_KEY; usiwahi kuinakili kwenye udhibiti wa chanzo (source control).

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

Matokeo yanayotarajiwa: A bounded client that handles transient failures without retry storms and is ready to add ETag-based conditional refreshes.

Wakati skripti ya kwanza inapokuwa mfumo halisi

Utatuzi wa matatizo na mwongozo wa uzalishaji

Tumia miongozo hii wakati jibu linashindwa, linarudisha data sifuri, au linahitaji udhibiti wa uzalishaji kama vile caching, timeouts, majaribio upya, na uwasilishaji wa matukio.

Mwongozo	Itumie wakati	Anza
Tambua jibu lililofeli au tupu	Tenganisha matatizo ya uthibitishaji, ufikiaji, njia, kikomo cha kiwango, na upatikanaji wa data bila kufichua funguo yako.	Fungua mwongozo →
Fanya mteja wa API awe tayari kwa uzalishaji	Ongeza muda wa kusubiri (timeouts), majaribio yenye mipaka, caching, maombi ya masharti, na mfumo sahihi wa uwasilishaji.	Fungua mwongozo →