przewodnik po workflow API

Co chcesz zbudować?

Wybierz wynik najbliższy Twojemu stanowisku. Każda ścieżka daje Ci jedno działające żądanie, informację o tym, co powinna zawierać odpowiedź, jak sprawdzić, czy zadziałało, oraz kolejny użyteczny krok.

Pięć praktycznych ścieżek

Zacznij od rezultatu, a nie od listy punktów końcowych.

Wybrano: Pobierz dane makro

Twój API okres próbny 14 dni

Przejdź od pierwszego zapytania do zadania wartego utrzymania.

Celem nie jest odwiedzanie każdej strony produktu. Celem jest wykonanie użytecznej, uwierzytelnionej pracy API, powrót innego dnia i wyjście z powtarzalnym zestawem danych lub przepływem pracy aplikacji.

Sprawdź postęp API

Dzień 0

Potwierdź dostęp

Utwórz klucz, wykonaj jedno uwierzytelnione żądanie i zapisz pierwszą odpowiedź wraz z jej metadanymi.

Otwórz krok →

Dni 1-2

Spraw, aby żądanie było niezawodne

Rozwiąż problemy z uwierzytelnianiem lub filtrowaniem i przekształć pierwszy skrypt w nazane, powtarzalne zadanie.

Otwórz krok →

Dni 3-4

Dodaj czas publikacji

Użyj kalendarza jako drugiej rodziny punktów końcowych i zaplanuj następne użyteczne uruchomienie API.

Otwórz krok →

Dni 5-7

Zbuduj wynik badań

Dodaj oczekiwania lub małą grupę szeregów makro, a następnie wygeneruj jedno zapisane porównanie, tabelę lub scorecard.

Otwórz krok →

Dni 8-10

Automatyzuj aktualizacje

Wybierz zaplanowane REST, SSE lub webhoki i ukończ kolejny udany przebieg API w innym dniu.

Otwórz krok →

Dni 11-13

Utwardź klienta

Dodaj limity czasu (timeouts), ograniczone ponowienia, walidację odpowiedzi, bezpieczne logowanie poświadczeń i monitorowanie nieaktualnych danych.

Otwórz krok →

Dzień 14

Przejrzyj dowody

Potwierdź, że API zapewnia powtarzalne zadanie, które Twój zespół będzie utrzymywał, a następnie wybierz kolejny zestaw danych lub proces aplikacji.

Otwórz krok →

Pierwsze żądanie

Pobieraj i zapisuj historię makro

Zacznij od jednej waluty i wskaźnika, który już rozumiesz. To ułatwia weryfikację uwierzytelniania, kształtu odpowiedzi, stronicowania i przechowywania przed dodaniem kolejnych szeregów.

10 minut Zacznij tutaj ogłoszenia

Działający przykład

Przechowuj swój klucz w FXMD_API_KEY; nigdy nie wklejaj go do kontroli wersji.

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

Oczekiwany wynik: Odpowiedź 200 z niedawnymi obserwacjami EUR inflation plus metadane odpowiedzi opisujące szereg, źródło, paginację i jakość danych.

Kiedy pierwszy skrypt staje się prawdziwym systemem

Rozwiązywanie problemów i wskazówki produkcyjne

Skorzystaj z tych przewodników, gdy odpowiedź nie powodzi się, nie zwraca danych lub wymaga kontroli produkcyjnych, takich jak buforowanie, limity czasu, ponowienia i dostarczanie zdarzeń.

PrzewodnikUżyj go, gdyStart
Zdiagnozuj nieudaną lub pustą odpowiedź Oddziel problemy z uwierzytelnianiem, dostępem, ścieżką, limitem żądań i dostępnością danych bez ujawniania swojego klucza. Otwórz przewodnik →
Przygotuj klienta API do produkcji Dodaj limity czasu, ograniczone ponowienia, buforowanie, żądania warunkowe i właściwy wzorzec dostarczania. Otwórz przewodnik →