تخطى إلى المحتوى

دليل سير عمل API

ماذا تريد أن تبني؟

اختر النتيجة الأقرب لوظيفتك. يمنحك كل مسار طلباً واحداً للعمل، وما يجب أن تحتويه الاستجابة، وكيفية التحقق من عمله، والخطوة المفيدة التالية.

خمسة مسارات عملية

ابدأ بالنتيجة، وليس بقائمة نقاط النهاية.

تم الاختيار: جلب البيانات الكلية

تجربة API لمدة 14 يوم الخاصة بك

انتقل من مجرد الطلب الأول إلى مهمة تستحق الاستمرار.

الهدف ليس زيارة كل صفحة منتج. الهدف هو إكمال عمل API مفيد وموثق، والعودة في يوم آخر، والمغادرة مع مجموعة بيانات أو سير عمل تطبيق قابل للتكرار.

تحقق من تقدم API

يوم 0

إثبات الوصول

أنشئ المفتاح، أكمل طلباً واحداً موثقاً، واحفظ الاستجابة الأولى مع بياناتها الوصفية.

فتح الخطوة ←

أيام 1-2

اجعل الطلب موثوقاً

حل مشكلات المصادقة أو التصفية وحوّل أول سكربت إلى وظيفة مكررة مسمى.

فتح الخطوة ←

أيام 3-4

إضافة توقيت الإصدار

استخدم التقويم كعائلة نقاط نهاية ثانية وجدول تشغيل API المفيد التالي.

فتح الخطوة ←

أيام 5-7

بناء مخرجات البحث

أضف التوقعات أو مجموعة صغيرة من السلاسل الكلية، ثم قم بإنشاء مقارنة واحدة أو جدول أو بطاقة أداء محفوظة.

فتح الخطوة ←

أيام 8-10

أتمتة التحديثات

اختر REST المجدول، أو SSE، أو webhooks وأكمل تشغيل 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])

النتيجة المتوقعة: استجابة 200 تحتوي على ملاحظات التضخم EUR الأخيرة بالإضافة إلى بيانات وصفية للاستجابة تصف السلسلة، والمصدر، والترقيم، وجودة البيانات.

عندما يصبح السكربت الأول نظاماً حقيقياً

استكشاف الأخطاء وإصلاحها وإرشادات الإنتاج

استخدم هذه الأدلة عندما يفشل الرد، أو لا يعيد أي بيانات، أو يحتاج إلى ضوابط الإنتاج مثل التخزين المؤقت، ومهلات الانتظار، وإعادة المحاولة، وتسليم الأحداث.

دليلاستخدمه عندماابدأ
تشخيص استجابة فاشلة أو فارغة فصل مشكلات المصادقة، والوصول، والمسار، وتحديد معدل الطلبات، وتوافر البيانات دون الكشف عن مفتاحك. فتح الدليل ←
اجعل عميل API جاهزاً للإنتاج أضف مهلات زمنية، وإعادة محاولات محدودة، وتخزين مؤقت، وطلبات مشروطة، ونمط التسليم الصحيح. فتح الدليل ←