راهنمای جریان کاری API

می‌خواهید چه چیزی بسازید؟

نتیجه‌ای را انتخاب کنید که به شغل شما نزدیک‌تر است. هر مسیر به شما یک درخواست کاری، آنچه پاسخ باید شامل شود، نحوه بررسی عملکرد آن و مرحله مفید بعدی را می‌دهد.

پنج مسیر کاربردی

با نتیجه شروع کنید، نه با لیست نقاط انتهایی.

Selected: Troubleshoot a request

دوره آزمایشی API به مدت 14 روز شما

از اولین درخواست به شغلی تبدیل شوید که ارزش نگه داشتن داشته باشد.

هدف بازدید از هر صفحه محصول نیست. هدف تکمیل کارهای احراز شده مفید API، بازگشت در روزی دیگر و خروج با یک مجموعه داده یا جریان کاری برنامه تکرارپذیر است.

بررسی پیشرفت API

روز 0

اثبات دسترسی

کلید را ایجاد کنید، یک درخواست احراز هویت شده را کامل کنید و اولین پاسخ را به همراه متادیتای آن ذخیره کنید.

باز کردن مرحله ←

روزهای 1-2

قابل اعتماد کردن درخواست

حل مشکلات احراز هویت یا فیلتر و تبدیل اولین اسکریپت به یک شغل تکرارپذیر نام‌گذاری شده.

باز کردن مرحله ←

روزهای 3-4

افزودن زمان‌بندی انتشار

از تقویم به عنوان خانواده دوم نقاط انتهایی (endpoint) استفاده کنید و زمان اجرای مفید بعدی API را برنامه‌ریزی کنید.

باز کردن مرحله ←

روزهای 5-7

ساخت خروجی تحقیق

انتظارات یا گروه کوچکی از سری‌های کلان را اضافه کنید، سپس یک مقایسه، جدول یا کارت امتیاز ذخیره شده ایجاد کنید.

باز کردن مرحله ←

روزهای 8-10

به‌روزرسانی‌ها را خودکار کنید

یک REST، SSE یا وب‌هوک‌های زمان‌بندی شده را انتخاب کنید و یک اجرای موفق API دیگر را در روزی متفاوت به پایان برسانید.

باز کردن مرحله ←

روزهای 11-13

مستحکم کردن کلاینت

اضافه کردن مهلت‌های زمانی (timeouts)، تلاش‌های مجدد محدود، اعتبارسنجی پاسخ، ثبت وقایع امن برای اعتبارنامه‌ها و نظارت بر داده‌های قدیمی.

باز کردن مرحله ←

روز 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اعلان‌ها

مثال کاربردی

کلید خود را در نگه دارید FXMD_API_KEY; هرگز آن را در کنترل منبع (source control) قرار ندهید.

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.

زمانی که اولین اسکریپت به یک سیستم واقعی تبدیل می‌شود

عیب‌یابی و راهنمای تولید

زمانی که یک پاسخ با شکست مواجه شد، داده‌ای برنگرداند یا به کنترل‌های تولیدی مانند کشینگ، تایم‌اوت‌ها، تلاش‌های مجدد و تحویل رویداد نیاز داشت، از این راهنماها استفاده کنید.

راهنمازمانی از آن استفاده کنید کهشروع
عیب‌یابی پاسخ‌های ناموفق یا خالی جداسازی مشکلات احراز هویت، دسترسی، مسیر، محدودیت نرخ و در دسترس بودن داده‌ها بدون افشای کلید شما. باز کردن راهنما ←
آماده‌سازی کلاینت API برای محیط عملیاتی افزودن timeoutها، تلاش‌های مجدد محدود، کشینگ، درخواست‌های شرطی و الگوی تحویل مناسب. باز کردن راهنما ←