API వర్క్‌ఫ్లో గైడ్

మీరు ఏమి నిర్మించాలనుకుంటున్నారు?

మీ పనికి అత్యంత దగ్గరగా ఉన్న ఫలితాన్ని ఎంచుకోండి. ప్రతి మార్గం మీకు ఒక వర్కింగ్ రిక్వెస్ట్, ప్రతిస్పందనలో ఏమి ఉండాలి, అది పనిచేసిందో లేదో ఎలా తనిఖీ చేయాలి మరియు తదుపరి ఉపయోగకరమైన దశను అందిస్తుంది.

ఐదు ప్రాక్టికల్ మార్గాలు

ఎండ్‌పాయింట్ జాబితాతో కాకుండా, ఫలితంతో ప్రారంభించండి.

ఎంచుకోబడింది: మ్యాక్రో డేటాను పొందండి

పాత్ 1 మాక్రో డేటాను పొందండి క్లీన్ టైమ్ సిరీస్‌ను పొందండి మరియు దాని పక్కనే సోర్స్ మరియు క్వాలిటీ మెటాడేటాను ఉంచుకోండి. పాత్ 2 రిలీజ్ జాబ్‌లను ప్లాన్ చేయండి తెలిసిన ప్రచురణ సమయాల చుట్టూ టార్గెటెడ్ జాబ్‌లను రన్ చేయడానికి రిలీజ్ క్యాలెండర్‌ను ఉపయోగించండి. పాత్ 3 సర్ప్రైజ్‌లను కొలవండి లుకహెడ్ బయాస్‌ను ప్రవేశపెట్టకుండా, ప్రచురించబడిన విలువకు ప్రీ-రిలీజ్ ఫోర్కాస్ట్‌లను జత చేయండి. పాత్ 4 లైవ్ అప్‌డేట్‌లను పొందండి SSE ను ఇన్వాలిడేషన్ సిగ్నల్‌గా ఉపయోగించండి, ఆపై REST నుండి పూర్తి రికార్డును పొందండి. మార్గం 5 మాక్రో మోడల్‌ను నిర్మించండి సంబంధిత ఇండికేటర్ల చిన్న సమూహాన్ని సోర్స్-లేబుల్డ్ కరెన్సీ స్కోర్‌కార్డ్‌గా మార్చండి.

మీ 14 రోజుల API ట్రయల్

మొదటి రిక్వెస్ట్ నుండి కొనసాగించదగ్గ ఉద్యోగం వరకు ఎదగండి.

లక్ష్యం ప్రతి ఉత్పత్తి పేజీని సందర్శించడం కాదు. ఉపయోగకరమైన అథెంటికేటెడ్ API పనిని పూర్తి చేయడం, మరొక రోజున తిరిగి రావడం మరియు రిపీటబుల్ డేటాసెట్ లేదా అప్లికేషన్ వర్క్‌ఫ్లోతో నిష్క్రమించడం.

API పురోగతిని తనిఖీ చేయండి

రోజు 0

యాక్సెస్‌ను నిరూపించండి

కీని సృష్టించండి, ఒక అథెంటికేటెడ్ రిక్వెస్ట్‌ను పూర్తి చేయండి మరియు దాని మెటాడేటాతో మొదటి రెస్పాన్స్‌ను సేవ్ చేయండి.

స్టెప్‌ను తెరవండి →

రోజులు 1-2

రిక్వెస్ట్‌ను ఆధారపడదగినదిగా చేయండి

అథెంటికేషన్ లేదా ఫిల్టర్ సమస్యలను పరిష్కరించండి మరియు మొదటి స్క్రిప్ట్‌ను పేరు చేయబడిన రిపీటబుల్ జాబ్‌గా మార్చండి.

స్టెప్‌ను తెరవండి →

రోజులు 3-4

విడుదల సమయాన్ని జోడించండి

క్యాలెండర్‌ను రెండవ ఎండ్‌పాయింట్ ఫ్యామిలీగా ఉపయోగించండి మరియు తదుపరి ఉపయోగకరమైన API రన్‌ను షెడ్యూల్ చేయండి.

స్టెప్‌ను తెరవండి →

రోజులు 5-7

పరిశోధన అవుట్‌పుట్‌ను నిర్మించండి

అంచనాలను లేదా చిన్న మాక్రో సిరీస్ సమూహాన్ని జోడించండి, ఆపై ఒక సేవ్ చేయబడిన పోలిక, టేబుల్ లేదా స్కోర్ కార్డ్‌ను రూపొందించండి.

స్టెప్‌ను తెరవండి →

రోజులు 8-10

అప్‌డేట్‌లను ఆటోమేట్ చేయండి

షెడ్యూల్ చేయబడిన REST, SSE, లేదా వెబ్‌హుక్స్‌ను ఎంచుకోండి మరియు మరొక రోజున మరొక విజయవంతమైన API రన్‌ను పూర్తి చేయండి.

స్టెప్‌ను తెరవండి →

రోజులు 11-13

క్లయింట్‌ను మరింత బలోపేతం చేయండి

టైమ్ అవుట్‌లు, బౌండెడ్ రీట్రైలు, రెస్పాన్స్ వాలిడేషన్, క్రెడెన్షియల్-సేఫ్ లాగింగ్ మరియు స్టెల్-డేటా మానిటరింగ్‌ను జోడించండి.

స్టెప్‌ను తెరవండి →

రోజు 14

ఆధారాలను సమీక్షించండి

API మీ బృందం కొనసాగించే పునరావృత ఉద్యోగాన్ని అందిస్తుందని ధృవీకరించండి, ఆపై తదుపరి డేటాసెట్ లేదా అప్లికేషన్ వర్క్‌ఫ్లోను ఎంచుకోండి.

స్టెప్‌ను తెరవండి →

మొదటి రిక్వెస్ట్

మాక్రో చరిత్రను పొందండి మరియు సేవ్ చేయండి

మీకు ఇప్పటికే తెలిసిన ఒక కరెన్సీ మరియు ఇండికేటర్‌తో ప్రారంభించండి. మీరు మరిన్ని సిరీస్‌లను జోడించకముందే అథెంటికేషన్, రెస్పాన్స్ షేప్, పేజినేషన్ మరియు స్టోరేజ్‌లను ధృవీకరించడం దీనివల్ల సులభం అవుతుంది.

10 నిమిషాలు ఇక్కడ ప్రారంభించండి ప్రకటనలు

పనిచేస్తున్న ఉదాహరణ

మీ కీని ఇందులో ఉంచుకోండి FXMD_API_KEY; దానిని ఎప్పుడూ సోర్స్ కంట్రోల్‌లో పేస్ట్ చేయవద్దు.

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

ఆశించిన ఫలితం: ఇటీవలి EUR ద్రవ్యోల్బణం పరిశీలనలతో కూడిన 200 రెస్పాన్స్ మరియు సిరీస్, మూలం, పేజినేషన్ మరియు డేటా నాణ్యతను వివరించే రెస్పాన్స్ మెటాడేటా.

మొదటి స్క్రిప్ట్ నిజమైన సిస్టమ్‌గా మారినప్పుడు

ట్రబుల్షూటింగ్ మరియు ప్రొడక్షన్ గైడెన్స్

రెస్పాన్స్ విఫలమైనప్పుడు, డేటా తిరిగి రానప్పుడు లేదా క్యాషింగ్, టైమ్ అవుట్‌లు, రీట్రైలు మరియు ఈవెంట్ డెలివరీ వంటి ప్రొడక్షన్ కంట్రోల్స్ అవసరమైనప్పుడు ఈ గైడ్‌లను ఉపయోగించండి.

గైడ్దీనిని ఎప్పుడు ఉపయోగించాలిప్రారంభించండి
విఫలమైన లేదా ఖాళీ ప్రతిస్పందనను నిర్ధారించండి మీ కీని బహిర్గతం చేయకుండా అథెంటికేషన్, యాక్సెస్, పాత్, రేట్-లిమిట్ మరియు డేటా-అవైలబిలిటీ సమస్యలను వేరు చేయండి. గైడ్‌ను తెరవండి →
API క్లయింట్‌ను ప్రొడక్షన్-రెడీగా చేయండి టైమ్‌అవుట్‌లు, బౌండెడ్ రీట్రైలు, క్యాషింగ్, కండిషనల్ రిక్వెస్ట్‌లు మరియు సరైన డెలివరీ ప్యాటర్న్‌ను జోడించండి. గైడ్‌ను తెరవండి →