водич за API работен процес

Што сакате да изградите?

Изберете го исходот што е најблизок до вашата работа. Секој пат ви дава еден работен барање, што треба да содржи одговорот, како да проверите дали работи и следниот корисен чекор.

Пет практични патеки

Започнете со исходот, а не со листата на ендпоинти.

Selected: Harden a client

Вашата API пробна верзија од 14 дена

Префрлете се од прв барање на работа вредна за чување.

Целта не е да се посети секоја страница на производ. Целта е да се заврши корисна автентицирана API работа, да се се вратите друг ден и да заминете со повторлив сет на податоци или работен тек на апликација.

Проверете го API напредокот

Ден 0

Докажи пристап

Креирајте го клучот, завршете еден автентифициран барање и зачувајте го првиот одговор со неговите метаподатоци.

Отвори чекор →

Денови 1-2

Направете го барањето доверливо

Резолвирајте проблеми со автентикација или филтри и претворете го првиот скрипт во именуван повторлив процес.

Отвори чекор →

Денови 3-4

Додај време на објавување

Користете го календарот како втор семеен ентитет (endpoint family) и закажете го следниот корисен API процес.

Отвори чекор →

Денови 5-7

Изградете го исходот од истражувањето

Додадете очекувања или мала група макро серии, а потоа генерирајте едно зачувано споредување, табела или резултатска картичка.

Отвори чекор →

Денови 8-10

Автоматизирајте ажурирања

Изберете закажани REST, SSE, или webhooks и завршете уште едно успешно API извршување на друг ден.

Отвори чекор →

Денови 11-13

Зајакнете го клиентот

Додадете timeout-и, ограничени повторни обиди, валидација на одговор, безбедно логување на пријава и мониторинг на застарени податоци.

Отвори чекор →

Ден 14

Прегледај докази

Потврдете дека API обезбедува повторлива работа што вашиот тим ќе ја одржува, потоа изберете го следниот сет на податоци или работен тек на апликацијата.

Отвори чекор →

Production readiness

Направете го API клиентот подготвен за продукција

Production reliability comes from treating status codes differently, keeping retries bounded, reusing ETags, and choosing scheduled REST, SSE, or webhooks for the job.

25 minutes Production pattern објавувањаchangesstreamwebhooks

Работен пример

Чувајте го вашиот клуч во FXMD_API_KEY; никогаш не го поставувајте во контрола на изворниот код.

import os
import requests
from urllib3.util.retry import Retry

session = requests.Session()
retry = Retry(total=3, backoff_factor=0.5, status_forcelist=(429, 502, 503, 504))
session.mount("https://", requests.adapters.HTTPAdapter(max_retries=retry))

response = session.get(
    "https://api.fxmacrodata.com/v1/announcements/eur/inflation",
    params={"api_key": os.environ["FXMD_API_KEY"], "limit": 5},
    headers={"Accept-Encoding": "gzip"},
    timeout=(3.05, 20),
)
response.raise_for_status()

Очекуван резултат: A bounded client that handles transient failures without retry storms and is ready to add ETag-based conditional refreshes.

Кога првиот скрипт станува вистински систем

Решавање проблеми и насоки за продукција

Користете ги овие води кога одговорот не успева, не враќа податоци или бара продукциски контроли како кеширање, timeout-и, повторни обиди и испорака на настани.

ВодичКористете го когаЗапочни
Дијагностицирај неуспешен или празен одговор Одвоете ги проблемите со автентикација, пристапот, патеката, ограничувањето на стапките и достапноста на податоците без да го откриете вашиот клуч. Отвори водич →
Направете го API клиентот подготвен за продукција Додај timeout-и, ограничени повторни обиди, кеширање, условни барања и соодветен модел на испорака. Отвори водич →