API ورک فلو گائیڈ

آپ کیا بنانا چاہتے ہیں؟

اپنے کام کے قریب ترین نتیجے کا انتخاب کریں۔ ہر راستہ آپ کو ایک فعال درخواست، جواب میں کیا ہونا چاہیے، یہ کیسے چیک کریں کہ اس نے کام کیا، اور اگلا مفید قدم فراہم کرتا ہے۔

پانچ عملی راستے

شروعات نتیجے سے کریں، اینڈ پوائنٹ کی فہرست سے نہیں۔

Selected: Troubleshoot a request

آپ کا 14 دن کا API ٹرائل

پہلی درخواست سے ایک ایسی ملازمت کی طرف بڑھیں جو برقرار رکھنے کے قابل ہو۔

مقصد ہر پروڈکٹ پیج پر جانا نہیں ہے۔ بلکہ مفید تصدیق شدہ API کام مکمل کرنا، کسی دوسرے دن واپس آنا، اور ایک قابلِ تکرار ڈیٹا سیٹ یا ایپلی کیشن ورک فلو کے ساتھ نکلنا ہے۔

API کی پیشرفت چیک کریں

دن 0

رسائی ثابت کریں

کی (key) بنائیں، ایک تصدیق شدہ درخواست مکمل کریں، اور پہلے جواب کو اس کے میٹا ڈیٹا کے ساتھ محفوظ کریں۔

اسٹیپ کھولیں →

دن 1-2

ریکویسٹ کو قابل اعتماد بنائیں

تصدیق یا فلٹر کے مسائل حل کریں اور پہلے اسکرپٹ کو ایک نامزد قابلِ تکرار جاب میں تبدیل کریں۔

اسٹیپ کھولیں →

دن 3-4

ریلیز کی ٹائمنگ شامل کریں

کیلنڈر کو دوسرے اینڈ پوائنٹ خاندان کے طور پر استعمال کریں اور اگلے مفید API رن کا شیڈول بنائیں۔

اسٹیپ کھولیں →

دن 5-7

ریسرچ آؤٹ پٹ بنائیں

توقعات یا میکرو سیریز کے ایک چھوٹے گروپ کو شامل کریں، پھر ایک محفوظ شدہ موازنہ، ٹیبل، یا اسکور کارڈ تیار کریں۔

اسٹیپ کھولیں →

دن 8-10

اپ ڈیٹس کو خودکار بنائیں

شیڈول شدہ REST، SSE، یا ویب ہکس منتخب کریں اور کسی دوسرے دن ایک اور کامیاب API رن مکمل کریں۔

اسٹیپ کھولیں →

دن 11-13

کلائنٹ کو مضبوط بنائیں

ٹائم آؤٹ، محدود ری ٹرائز، جواب کی تصدیق، کریڈنشل-سیف لاگنگ، اور اسٹیل-ڈیٹا مانیٹرنگ شامل کریں۔

اسٹیپ کھولیں →

دن 14

شواہد کا جائزہ لیں

تصدیق کریں کہ API ایک قابلِ تکرار کام فراہم کرتا ہے جسے آپ کی ٹیم برقرار رکھے گی، پھر اگلا ڈیٹا سیٹ یا ایپلی کیشن ورک فلو منتخب کریں۔

اسٹیپ کھولیں →

Request help

ناکام یا خالی جواب کی تشخیص کریں

Inspect the status and a short error body, then follow the matching fix. Never paste an API key or a full authenticated URL into a support message.

10 منٹ Troubleshooting authenticationاعلانات

کام کرنے والی مثال

اپنی کی (key) کو یہاں رکھیں FXMD_API_KEY; اسے کبھی بھی سورس کنٹرول میں پیسٹ نہ کریں۔

import os
import requests

key = os.getenv("FXMD_API_KEY", "").strip()
if not key:
    raise RuntimeError("FXMD_API_KEY is not set")

response = requests.get(
    "https://api.fxmacrodata.com/v1/announcements/eur/inflation",
    params={"api_key": key, "limit": 1},
    timeout=20,
)
print(response.status_code, response.text[:300])

متوقع نتیجہ: A 200 confirms the key and path work. A 401 or 403 points to authentication or access, a 404 to the path, and a 429 to request pacing.

جب پہلا اسکرپٹ ایک حقیقی سسٹم بن جائے

ٹربل شوٹنگ اور پروڈکشن رہنمائی

ان گائیڈز کا استعمال کریں جب کوئی جواب ناکام ہو جائے، کوئی ڈیٹا واپس نہ ملے، یا پروڈکشن کنٹرولز جیسے کیشنگ، ٹائم آؤٹ، ری ٹرائیز، اور ایونٹ ڈیلیوری کی ضرورت ہو۔

گائیڈاسے تب استعمال کریں جبشروع کریں
ناکام یا خالی جواب کی تشخیص کریں اپنی کی (key) کو ظاہر کیے بغیر تصدیق، رسائی، راستے، ریٹ لمٹ، اور ڈیٹا کی دستیابی کے مسائل کو الگ الگ کریں۔ گائیڈ کھولیں →
ایک API کلائنٹ کو پروڈکشن کے لیے تیار کریں ٹائم آؤٹ، محدود ری ٹرائیز، کیشنگ، مشروط درخواستیں، اور درست ڈیلیوری پیٹرن شامل کریں۔ گائیڈ کھولیں →