API աշխատանքային հոսքի ուղեցույց

Ի՞նչ եք ցանկանում ստեղծել:

Ընտրեք ձեր աշխատանքին ամենամոտ արդյունքը: Յուրաքանչյուր ուղի ձեզ տալիս է մեկ աշխատանքային հարցում, թե ինչ պետք է պարունակի պատասխանը, ինչպես ստուգել դրա աշխատանքը և հաջորդ օգտակար քայլը:

Հինգ գործնական ուղիներ

Սկսեք արդյունքից, այլոչ թե endpoint-ների ցանկից:

Ընտրված է՝ Ստանալ մակրո տվյալներ

Ձեր 14-օրյա API փորձաշրջանը

Անցեք առաջին հարցումից դեպի պահպանելու արժանի աշխատանք:

Նպատակը ոչ թե յուրաքանչյուր ապրանքի էջ այցելելն է: Նպատակն է կատարել օգտակար վավերացված API աշխատանք, վերադառնալ մեկ այլ օր և հեռանալ կրկնվող տվյալների հավաքածուով կամ աշխատանքային գործընթացով:

Ստուգել API ilerդումը

Օր 0

Ապացուցել հասանելիությունը

Ստեղծեք բանալին, կատարեք մեկ վավերացված հարցում և պահպանեք առաջին պատասխանը իր մետատվյալներով:

Բացել քայլը →

Օր 1-2

Դարձրեք հարցումը հուսալի

Լուծեք նույնականացման կամ զտման (filter) խնդիրները և առաջին սկրիպտը վերածեք անվանված կրկնվող առաջադրանքի:

Բացել քայլը →

Օրեր 3-4

Ավելացնել հրապարակման ժամանակը

Օգտագործեք օրացույցը որպես երկրորդ endpoint ընտանիք և պլանավորեք հաջորդ օգտակար API գործարկումը:

Բացել քայլը →

Օրեր 5-7

Կառուցել հետազոտական արդյունքը

Ավելացրեք սպասելիքներ կամ մակրո սերիաների փոքր խումբ, այնուհետև ստեղծեք մեկ պահպանված համեմատություն, աղյուսակ կամ հաշվեկշիռ:

Բացել քայլը →

Օր 8-10

Ավտոմատացրեք թարմացումները

Ընտրեք պլանավորված REST, SSE կամ webhooks և կատարեք ևս մեկ հաջողված API գործարկում այլ օր:

Բացել քայլը →

Օրեր 11-13

Ամրապնդել client-ը

Ավելացրեք timeout-ներ, սահմանափակված կրկնություններ, պատասխանի վավերացում, վավերացման անվտանգ լոգավորում և հնացած տվյալների մոնիթորինգ:

Բացել քայլը →

Օր 14

Վերանայել ապացույցները

Հաստատեք, որ API-ը մատակարարում է կրկնելի աշխատանք, որը ձեր թիմը կպահպանի, այնուհետև ընտրեք հաջորդ հավելվածների հավաքածուն կամ աշխատանքային հոսքը:

Բացել քայլը →

Առաջին հարցում

Հավաքել և պահպանել մակրո պատմությունը

Սկսեք մեկ արժույթից և ցուցիչից, որն արդեն հասկանում եք: Սա հեշտացնում է աուտենտիֆիկացիան, պատասխանի ձևը, էջերի բաժանումը (pagination) և պահպանումը՝ նախքան ավելի շատ շարքեր ավելացնելը:

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 ինֆլացիայի դիտարկումներով, պլյուս պատասխանի մետատվյալներ, որոնք նկարագրում են շարքը, աղբյուրը, էջերի համարակալումը և տվյալների որակը:

Երբ առաջին սկրիպտը դառնում է իրական համակարգ

Խնդիրների հարթում և արտադրական ուղեցույց

Օգտագործեք այս ուղեցույցները, երբ պատասխանը ձախողվում է, տվյալներ չի վերադարձնում կամ պահանջում է արտադրական վերահսկողություն, ինչպիսիք են caching-ը, timeout-ները, կրկնությունները և իրադարձությունների առաքումը:

ՈւղեցույցՕգտագործեք այն, երբՍկսել
Ախտորոշել ձախողված կամ դատարկ պատասխանը Առանձնացրեք նույնականացման, հասանելիության, ուղու, սահմանափակման (rate-limit) և տվյալների հասանելիության խնդիրները՝ առանց ձեր բանալին բացահայտելու: Բացել ուղեցույցը →
Դարձրեք API հաճախորդին արտադրական պատրաստության մեջ Ավելացնել ժամանակի սահմանափակումներ (timeouts), սահմանափակ փորձեր (bounded retries), քեշավորում, պայմանական հարցումներ և առաքման ճիշտ օրինաչափություն: Բացել ուղեցույցը →