API वर्कफ्लो मार्गदर्शक

तुम्हाला काय तयार करायचे आहे?

तुमच्या कामाच्या सर्वात जवळचा परिणाम निवडा. प्रत्येक मार्ग तुम्हाला एक कार्यरत विनंती, प्रतिसादात काय असावे, ते काम केले आहे की नाही हे कसे तपासावे आणि पुढील उपयुक्त पायरी देतो.

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

एंडपॉइंट लिस्टऐवजी परिणामापासून सुरुवात करा.

Selected: Harden a client

तुमची 14-दिवसांची API ट्रायल

पहिल्या विनंतीपासून कायमस्वरूपी ठेवण्यायोग्य जॉबपर्यंत पोहोचा.

ध्येय प्रत्येक उत्पादन पृष्ठाला भेट देणे नाही. तर उपयुक्त ऑथेंटिकेटेड API काम पूर्ण करणे, दुसऱ्या दिवशी परत येणे आणि रिपीट करण्यायोग्य डेटासेट किंवा ॲप्लिकेशन वर्कफ्लोसह बाहेर पडणे हे आहे.

API प्रगती तपासा

दिवस 0

प्रवेश सिद्ध करा

की (key) तयार करा, एक प्रमाणित विनंती पूर्ण करा आणि त्याचे मेटाडेटासह पहिले प्रतिसाद जतन करा.

पायरी उघडा →

दिवस 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

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

तुमची की यामध्ये ठेवा 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.

जेव्हा पहिली स्क्रिप्ट खऱ्या सिस्टममध्ये रूपांतरित होते

ट्रबलशूटिंग आणि उत्पादन मार्गदर्शन

जेव्हा प्रतिसाद अयशस्वी होतो, कोणताही डेटा मिळत नाही किंवा कॅशिंग, टाइमआउट्स, रिट्रायज आणि इव्हेंट डिलिव्हरी सारख्या प्रोडक्शन कंट्रोल्सची आवश्यकता असते तेव्हा या गाईड्सचा वापर करा.

मार्गदर्शकयाचा वापर करा जेव्हासुरुवात करा
अयशस्वी किंवा रिकाम्या प्रतिसादाचे निदान करा तुमची की उघड न करता ऑथेंटिकेशन, प्रवेश, पाथ, रेट-लिमिट आणि डेटा-उपलब्धता समस्या वेगळ्या करा. गाईड उघडा →
API क्लायंट प्रोडक्शन-रेडी करा टाइमआउट्स, मर्यादित रिट्रायज, कॅशिंग, कंडिशनल रिक्वेस्ट्स आणि योग्य डिलिव्हरी पॅटर्न जोडा. गाईड उघडा →