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

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

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

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

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

Selected: Receive live updates

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

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

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

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

День 0

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

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

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

Дні 1-2

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

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

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

Дні 3-4

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

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

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

Дні 5-7

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

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

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

Дні 8-10

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

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

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

Дні 11-13

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

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

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

День 14

Переглянути докази

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

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

Real-time workflow

Receive release updates

A long-lived event stream can notify your application when matching macro data changes. The event is the trigger; the announcements endpoint remains the source for the full response.

20 minutes Application workflow streamоголошення

Працюючий приклад

Зберігайте свій ключ у FXMD_API_KEY; ніколи не вставляйте його в систему контролю версій.

curl -N --get \
  "https://api.fxmacrodata.com/v1/stream/events" \
  --data-urlencode "currencies=eur" \
  --data-urlencode "indicators=inflation" \
  --data-urlencode "api_key=$FXMD_API_KEY"

Очікуваний результат: A persistent filtered stream. When an event arrives, your worker fetches the related announcements endpoint and updates its local cache.

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

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

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

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