посібник з робочого процесу API

Що ви хочете створити?

Виберіть результат, найближчий до вашої задачі. Кожен шлях надає вам один робочий запит, інформацію про те, що має містити відповідь, як перевірити її роботу, та наступний корисний крок.

П'ять практичних шляхів

Почніть з результату, а не зі списку ендпоінтів.

Selected: Measure surprises

Ваша 14-денна пробна версія API

Перейдіть від першого запиту до роботи, якою варто пишатися.

Мета не в тому, щоб відвідати кожну сторінку продукту. Мета полягає в тому, щоб виконати корисну автентифіковану роботу API, повернутися в інший день і залишити після себе повторюваний набір даних або робочий процес додатка.

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

День 0

Підтвердити доступ

Створіть ключ, виконайте один автентифікований запит і збережіть першу відповідь разом з її метаданими.

Відкрити крок →

Дні 1-2

Зробити запит надійним

Вирішіть проблеми з автентифікацією або фільтрацією та перетворіть перший скрипт на іменоване повторюване завдання.

Відкрити крок →

Дні 3-4

Додати час релізу

Використовуйте календар як другу родину ендпоінтів і заплануйте наступний корисний запуск API.

Відкрити крок →

Дні 5-7

Створити результат дослідження

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

Відкрити крок →

Дні 8-10

Автоматизуйте оновлення

Виберіть заплановані REST, SSE або вебхуки та виконайте ще один успішний запуск API в інший день.

Відкрити крок →

Дні 11-13

Зміцнити клієнта

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

Відкрити крок →

День 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.

Коли перший скрипт стає реальною системою

Усунення несправностей та керівництво з експлуатації

Використовуйте ці посібники, якщо відповідь не вдалася, не повернула даних або потребує виробничого контролю, такого як кешування, тайм-аути, повторні спроби та доставка подій.

ПосібникВикористовуйте це, колиСтарт
Діагностика помилкової або порожньої відповіді Розділяйте проблеми автентифікації, доступу, шляху, ліміту запитів та доступності даних, не розкриваючи свій ключ. Відкрити посібник →
Підготувати клієнта API до виробничого використання Додайте таймаути, обмежені повторні спроби, кешування, умовні запити та правильний шаблон доставки. Відкрити посібник →