מדריך תהליך עבודה של API

מה אתה רוצה לבנות?

בחר את התוצאה הקרובה ביותר למשימה שלך. כל נתיב נותן לך בקשה אחת עובדת, מה התגובה צריכה להכיל, איך לבדוק שזה עבד, והשלב המועיל הבא.

חמישה נתיבים מעשיים

התחל עם התוצאה, לא עם רשימת נקודות הקצה.

נבחר: משוך נתוני מאקרו

תקופת הניסיון של API למשך 14 ימים שלך

עברו מבקשה ראשונה לעבודה ששווה לשמור.

המטרה אינה לבקר בכל דף מוצר. המטרה היא להשלים עבודת API מאומתת ומועילה, לחזור ביום אחר, ולצאת עם סט נתונים או תהליך עבודה של אפליקציה שניתן לחזור עליו.

בדוק התקדמות API

יום 0

הוכח גישה

צור את המפתח, בצע בקשה מאומתת אחת, ושמור את התגובה הראשונה עם המטא-נתונים שלה.

פתח שלב ←

ימים 1-2

הפוך את הבקשה לאמינה

פתור בעיות אימות או סינון והפוך את הסקריפט הראשון למשימה שמימה שניתן לחזור עליה.

פתח שלב ←

ימים 3-4

הוסף תזמון פרסום

השתמש בלוח השנה כמשפחת נקודות קצה שנינית ותזמן את הרצת ה-API המועילה הבאה.

פתח שלב ←

ימים 5-7

בנה את פלט המחקר

הוסף ציפיות או קבוצה קטנה של סדרות מאקרו, ואז הפק השוואה, טבלה או כרטיס ניקוד שמור אחד.

פתח שלב ←

ימים 8-10

אוטומציה של עדכונים

בחר REST, SSE מתוזמנים, או webhooks והשלם הרצה מוצלחת נוספת של API ביום אחר.

פתח שלב ←

ימים 11-13

חיזוק הלקוח

הוסף פסק זמן (timeouts), ניסיונות חוזרים מוגבלים, אימות תגובה, רישום (logging) בטוח לסיסמאות וניטור נתונים לא עדכניים.

פתח שלב ←

יום 14

בקר ראיות

אשרו שה-API מספק עבודה ניתנת לשחזור שהצוות שלכם ישמור, ואז בחרו את סט הנתונים או תהליך עבודת האפליקציה הבא.

פתח שלב ←

בקשה ראשונה

שליפה ושמירה של היסטוריית מאקרו

התחל עם מטבע ואינדיקטור אחד שאתה כבר מכיר. זה הופך את האימות, מבנה התגובה, הדפדוף והאחסון לקלים לאימות לפני שתוסיף סדרות נוספות.

דקות 10 התחילו כאן הודעות

דוגמה עובדת

שמור את המפתח שלך ב FXMD_API_KEY; לעולם אל תדביק אותו בבקרת מקור (source control).

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 בתוספת מטא-נתוני תגובה המתארים את הסדרה, המקור, הדפדופים ואיכות הנתונים.

כאשר הסקריפט הראשון הופך למערכת אמיתית

פתרון בעיות והנחיות ייצור

השתמשו במדריכים אלו כאשר תגובה נכשלת, אינה מחזירה נתונים, או זקוקה לבקרות ייצור כגון מטמון (caching), פסק זמן (timeouts), ניסיונות חוזרים ומסירת אירועים.

מדריךהשתמש בזה כאשרהתחל
אבחון תגובה שנכשלה או ריקה הפרד בין בעיות אימות, גישה, נתיב, הגבלת קצב וזמינות נתונים מבלי לחשוף את המפתח שלך. פתח מדריך ←
הפוך לקוח API למוכן לייצור הוסף הגבלות זמן (timeouts), ניסיונות חוזרים מוגבלים, מטמון (caching), בקשות מותנות ותבנית מסירה נכונה. פתח מדריך ←