Guia de flux de treball API

Què voleu construir?

Tria el resultat més proper a la teva feina. Cada ruta et proporciona una petició funcionals, el que la resposta ha de contenir, com comprovar que ha funcionat i el següent pas útil.

Cinc vies pràctiques

Comenceu amb el resultat, no amb la llista d'endpoints.

Seleccionat: Recuperar dades macro

La seva prova de API de 14 dies

Passa de la primera petició a una tasca que val la pena mantenir.

L'objectiu no és visitar cada pàgina de producte. És completar una feina API autenticada i útil, tornar un altre dia i marxar amb un conjunt de dades o un flux de treball d'aplicació repetible.

Comprova el progrés de API

Dia 0

Demostra l'accés

Crea la clau, completa una petició autenticada i guarda la primera resposta amb la seva metàdata.

Obre el pas →

Dies 1-2

Fes que la petició sigui fiable

Resoleu problemes d'autenticació o de filtres i convertiu el primer script en una tasca anomenada i repetible.

Obre el pas →

Dies 3-4

Afegir temps de publicació

Utilitzeu el calendari com a una segona família d'endpoints i programeu la propera execució útil de API.

Obre el pas →

Dies 5-7

Construeix el resultat de la recerca

Afegeix expectatives o un petit grup de sèries macro, i després genera una comparació, taula o scorecard guardada.

Obre el pas →

Dies 8-10

Automatitza les actualitzacions

Tria REST, SSE programats o webhooks i completa una altra execució de API amb èxit un dia diferent.

Obre el pas →

Dies 11-13

Endureix el client

Afegeix timeouts, reintentos limitats, validació de respostes, registres segurs de credencials i monitoratge de dades obsoletes.

Obre el pas →

Dia 14

Revisa l'evidència

Confirma que el API proporciona una tasca repetible que el teu equip mantindrà, i després tria el següent conjunt de dades o flux de treball d'aplicació.

Obre el pas →

Primera petició

Recollir i guardar l'historial macro

Comença amb una moneda i un indicador que ja entenguis. Això facilita la verificació de l'autenticació, la forma de la resposta, la paginació i l'emmagatzematge abans d'afegir més sèries.

10 minuts Comença aquí anuncis

Exemple de funcionament

Mantingui la seva clau a FXMD_API_KEY; mai el enganxes al control de fonts.

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

Resultat esperat: Una resposta 200 amb observacions d'inflació EUR recents més la metàdata de la resposta que descriu la sèrie, la font, la paginació i la qualitat de les dades.

Quan el primer script es converteix en un sistema real

Resolució de problemes i guia de producció

Utilitza aquestes guies quan una resposta falli, no retorni dades o necessiti controls de producció com l'emmagatzematge en memòria cau, temps d'espera, reintentos i lliurament d'esdeveniments.

GuiaUtilitzeu-lo quanInici
Diagnosticar una resposta fallida o buida Separeu problemes d'autenticació, accés, ruta, límit de velocitat i disponibilitat de dades sense exposar la vostra clau. Obre la guia →
Fes que un client API estigui preparat per a la producció Afegeix timeouts, reintentos limitats, memòria cau, sol·licituds condicionals i el patró de lliurament adequat. Obre la guia →