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

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

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

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

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

Избрано: Преземи макро податоци

Вашата 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 обезбедува повторлива работа што вашиот тим ќе ја одржува, потоа изберете го следниот сет на податоци или работен тек на апликацијата.

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

Прво барање

Преземи и зачувај макро историја

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

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])

Очекуван резултат: A 200 одговор со неодамнешни EUR инфлациони забелешки плус метаподатоци на одговорот кои ја опишуваат серијата, изворот, пагинацијата и квалитетот на податоците.

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

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

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

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