API कार्यप्रवाह गाइड

तपाईं के निर्माण गर्न चाहनुहुन्छ?

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

एक कार्यप्रवाह छान्नुहोस् API Management खोल्नुहोस्

पाँच व्यावहारिक पथहरू

इन्डपोइन्ट सूचीबाट होइन, परिणामबाट सुरु गर्नुहोस्।

Selected: Harden a client

पथ 1 म्याक्रो डाटा प्राप्त गर्नुहोस् एक सफा टाइम सिरिज प्राप्त गर्नुहोस् र यसको साथमा स्रोत र गुणस्तर मेटाडाटा राख्नुहोस्। पथ 2 riliease कार्यहरू योजना बनाउनुहोस् ज्ञात प्रकाशन समयहरूको वरिपरि लक्षित कामहरू चलाउन रिलिज क्यालेन्डर प्रयोग गर्नुहोस्। पाथ 3 आश्चर्यहरू मापन गर्नुहोस् लुकअहेड बायस (lookahead bias) नल्याईकन प्रकाशित मानमा प्रि-रिलिज पूर्वानुमानहरू जोड्नुहोस्। पथ 4 लाइभ अपडेटहरू प्राप्त गर्नुहोस् SSE लाई अमान्यकरण संकेतको रूपमा प्रयोग गर्नुहोस्, त्यसपछि REST बाट पूर्ण रेकर्ड प्राप्त गर्नुहोस्। पाथ 5 एक म्याक्रो मोडेल निर्माण गर्नुहोस् सम्बन्धित सूचकहरूको सानो समूहलाई स्रोत-लेबल गरिएको मुद्रा स्कोरकार्डमा बदल्नुहोस्।

तपाईंको 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

काम गर्ने उदाहरण

तपाईंको कुञ्जी (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.

जब पहिलो स्क्रिप्ट वास्तविक प्रणाली बन्छ

समस्या निवारण र उत्पादन मार्गदर्शन

जब प्रतिक्रिया असफल हुन्छ, कुनै डाटा फर्काउँदैन, वा क्याशिङ, टाइमआउट, रिट्राइ, र इभेन्ट डेलिभरी जस्ता उत्पादन नियन्त्रणहरू आवश्यक हुन्छन् तब यी गाइडहरू प्रयोग गर्नुहोस्।

मार्गदर्शनयसलाई प्रयोग गर्नुहोस् जबसुरु गर्नुहोस्
असफल वा खाली प्रतिक्रियाको निदान गर्नुहोस् तपाईंको कुञ्जी उजागर नगरी प्रमाणीकरण, पहुँच, पाथ, दर-सीमा, र डाटा-उपलब्धता समस्याहरूलाई अलग गर्नुहोस्। मार्गदर्शक खोल्नुहोस् →
एक API क्लाइन्टलाई उत्पादन-तयार बनाउनुहोस् टाइमआउटहरू, सीमित पुन: प्रयासहरू, क्याशिङ, सर्त अनुरोधहरू, र सही डेलिभरी प्याटर्न थप्नुहोस्। मार्गदर्शक खोल्नुहोस् →