Ръководство за API работен процес

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

Изберете резултата, най-близък до вашата работа. Всеки път ви дава една работна заявка, какво трябва да съдържа отговорът, как да проверите дали е проработило и следващата полезна стъпка.

Пет практически пътя

Започнете с резултата, а не със списъка с крайни интерфейси.

Selected: Measure surprises

Вашият API пробен период от 14 дни

Преминете от първо искане към работа, която си струва да се поддържа.

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

Проверете API прогрес

Ден 0

Докажи достъп

Създайте ключа, изпълнете една автентифицирана заявка и запишете първия отговор с неговите метаданни.

Отвори стъпка →

Дни 1-2

Направете заявката надеждна

Решаване на проблеми с автентикация или филтриране и превръщане на първия скрипт в именована повтаряема задача.

Отвори стъпка →

Дни 3-4

Добавете време на оповещение

Използвайте календара като втори клас крайни точки и планирайте следващото полезно изпълнение на API.

Отвори стъпка →

Дни 5-7

Изградете резултата от проучването

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

Отвори стъпка →

Дни 8-10

Автоматизирайте актуализациите

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

Отвори стъпка →

Дни 11-13

Укрепете клиента

Добавете изчаквания (timeouts), ограничени повторения, валидация на отговори, безопасно логване на данни и мониторинг на остарели данни.

Отвори стъпка →

Ден 14

Прегледай доказателствата

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

Отвори стъпка →

Expectations workflow

Compare forecasts with actual releases

Use predictions before the event, preserve the forecast timestamp, then join the released observation by announcement identity for a repeatable surprise series.

20 minutes Research workflow прогнозианонси

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

Запазете вашия ключ в FXMD_API_KEY; никога не го поставяйте в контрол на версиите.

import os
import requests

params = {
    "api_key": os.environ["FXMD_API_KEY"],
    "pre_release_only": "true",
    "limit": 5,
}
response = requests.get(
    "https://api.fxmacrodata.com/v1/predictions/eur/inflation",
    params=params,
    timeout=20,
)
response.raise_for_status()
print(response.json()["data"][0])

Очакван резултат: Recent EUR inflation release groups with source-labelled forecasts that were recorded before each announcement.

Когато първият скрипт стане реална система

Отстраняване на проблеми и производствени насоки

Използвайте тези ръководства, когато отговорът е неуспешен, не връща данни или се нуждае от производствени контроли като кеширане, изчаквания (timeouts), повторни опити и доставка на събития.

РъководствоИзползвайте го, когатоСтарт
Диагностициране на неуспешен или празен отговор Разделяне на проблеми с автентикация, достъп, път, ограничаване на честотата и наличност на данни без разкриване на вашия ключ. Отворете ръководство →
Направете API клиент готов за производство Добавете тайм-аути, ограничени повторни опити, кеширане, условни заявки и правилния модел на доставка. Отворете ръководство →