सामग्री पर जाएँ

API वर्कफ़्लो गाइड

आप क्या बनाना चाहते हैं?

अपने काम के सबसे करीब परिणाम चुनें। प्रत्येक पाथ आपको एक वर्किंग अनुरोध, प्रतिक्रिया में क्या होना चाहिए, यह कैसे जांचें कि यह काम कर रहा है, और अगला उपयोगी कदम देता है।

पाँच व्यावहारिक मार्ग

परिणाम से शुरू करें, एंडपॉइंट सूची से नहीं।

Selected: Harden a client

आपका 14-दिवसीय API परीक्षण

पहले अनुरोध से एक ऐसे कार्य की ओर बढ़ें जो बनाए रखने योग्य हो।

लक्ष्य हर प्रोडक्ट पेज पर जाना नहीं है। लक्ष्य उपयोगी प्रमाणित API कार्य पूरा करना, दूसरे दिन वापस आना, और एक दोहराने योग्य डेटासेट या एप्लिकेशन वर्कफ़्लो के साथ जाना है।

API प्रगति की जांच करें

दिन 0

एक्सेस सिद्ध करें

कुंजी बनाएं, एक प्रमाणित अनुरोध पूरा करें, और पहले रिस्पॉन्स को उसके मेटाडेटा के साथ सहेजें।

चरण खोलें →

दिन 1-2

अनुरोध को भरोसेमंद बनाएं

ऑथेंटिकेशन या फ़िल्टर समस्याओं को हल करें और पहले स्क्रिप्ट को एक नामित दोहराने योग्य जॉब में बदलें।

चरण खोलें →

दिन 3-4

रिलीज़ टाइमिंग जोड़ें

कैलेंडर को दूसरे एंडपॉइंट परिवार के रूप में उपयोग करें और अगला उपयोगी API रन शेड्यूल करें।

चरण खोलें →

दिन 5-7

रिसर्च आउटपुट बनाएं

अपेक्षाएं या मैक्रो सीरीज़ का एक छोटा समूह जोड़ें, फिर एक सहेजा गया तुलना, तालिका, या स्कोरकार्ड बनाएं।

चरण खोलें →

दिन 8-10

अपडेट स्वचालित करें

अनुसूचित REST, SSE, या वेबहुक चुनें और किसी अन्य दिन एक और सफल API रन पूरा करें।

चरण खोलें →

दिन 11-13

क्लाइंट को मजबूत बनाएं

टाइमआउट, बाउंडेड रिट्राइज़, रिस्पॉन्स वैलिडेशन, क्रेडेंशियल-सेफ लॉगिंग और स्टेल-डेटा मॉनिटरिंग जोड़ें।

चरण खोलें →

दिन 14

साक्ष्य की समीक्षा करें

पुष्टि करें कि API एक दोहराने योग्य जॉब प्रदान करता है जिसे आपकी टीम बनाए रखेगी, फिर अगला डेटासेट या एप्लिकेशन वर्कफ़्लो चुनें।

चरण खोलें →

Production readiness

API क्लाइंट को प्रोडक्शन-रेडी बनाएं

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 घोषणाएंchangesstreamwebhooks

कार्यकारी उदाहरण

अपनी की (key) को इसमें रखें FXMD_API_KEY; इसे कभी भी सोर्स कंट्रोल में पेस्ट न करें।

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

अपेक्षित परिणाम: A bounded client that handles transient failures without retry storms and is ready to add ETag-based conditional refreshes.

जब पहला स्क्रिप्ट एक वास्तविक सिस्टम बन जाता है

ट्रबलशूटिंग और प्रोडक्शन मार्गदर्शन

जब कोई प्रतिक्रिया विफल हो जाती है, कोई डेटा नहीं लौटाती है, या कैशिंग, टाइमआउट, रिट्राइज़ और इवेंट डिलीवरी जैसे प्रोडक्शन नियंत्रणों की आवश्यकता होती है, तो इन गाइडों का उपयोग करें।

गाइडइसका उपयोग तब करें जबशुरू करें
विफल या खाली रिस्पॉन्स का निदान करें अपनी की (key) को उजागर किए बिना प्रमाणीकरण, एक्सेस, पाथ, रेट-लिमिट और डेटा-उपलब्धता की समस्याओं को अलग करें। गाइड खोलें →
API क्लाइंट को प्रोडक्शन-रेडी बनाएं टाइमआउट, बाउंडेड रिट्राइज़, कैशिंग, कंडीशनल रिक्वेस्ट, और सही डिलीवरी पैटर्न जोड़ें। गाइड खोलें →