Guía de fluxo de traballo API

Que queres construír?

Elixe o resultado máis próximo ao teu traballo. Cada ruta dache unha solicitude de traballo, o que debe conter a resposta, como comprobar que funcionou e o próximo paso útil.

Cinco rutas prácticas

Comeza co resultado, non coa lista de endpoints.

Selected: Harden a client

A súa proba de API de 14 días

Pasa da primeira solicitude a un traballo que merece a pena manter.

O obxectivo non é visitar cada páxina de produto. É completar un traballo útil autenticado de API, volver noutro día e marchar cun conxunto de datos repetible ou un fluxo de traballo de aplicación.

Comprobar progreso de API

Día 0

Probar acceso

Crea a chave, completa unha requisição autenticada e garda a primeira resposta coa súa metadatos.

Abrir paso →

Días 1-2

Facer a petición dependíble

Resolva problemas de autenticación ou de filtro e converta o primeiro script nun xogo nomeado e repetible.

Abrir paso →

Días 3-4

Añadir tempo de publicación

Use o calendario como unha segunda familia de endpoints e programe a próxima execución útil de API.

Abrir paso →

Días 5-7

Construír o resultado da investigación

Engade expectativas ou un pequeno grupo de series macro, e despois xera unha comparación, táboa ou scorecard gardada.

Abrir paso →

Días 8-10

Automatizar actualizacións

Elixe REST, SSE programados ou webhooks e completa outra execución exitosa de API nun día diferente.

Abrir paso →

Días 11-13

Reforzar o cliente

Engade tempos de espera, reintentos limitados, validación de resposta, rexistro seguro de credenciais e monitorización de datos caducos.

Abrir paso →

Día 14

Revisar evidencia

Confirma que o API proporciona un traballo repetible que o teu equipo manterá, e despois elixe o próximo conxunto de datos ou fluxo de traballo de aplicación.

Abrir paso →

Production readiness

Facer un cliente de API listo para produción

Production reliability comes from treating status codes differently, keeping retries bounded, reusing ETags, and choosing scheduled REST, SSE, or webhooks for the job.

25 minutes Production pattern anuncioschangesstreamwebhooks

Exemplo de funcionamento

Gardar a súa clave en FXMD_API_KEY; nunca o pegues no control de fontes.

import os
import requests
from urllib3.util.retry import Retry

session = requests.Session()
retry = Retry(total=3, backoff_factor=0.5, status_forcelist=(429, 502, 503, 504))
session.mount("https://", requests.adapters.HTTPAdapter(max_retries=retry))

response = session.get(
    "https://api.fxmacrodata.com/v1/announcements/eur/inflation",
    params={"api_key": os.environ["FXMD_API_KEY"], "limit": 5},
    headers={"Accept-Encoding": "gzip"},
    timeout=(3.05, 20),
)
response.raise_for_status()

Resultado esperado: A bounded client that handles transient failures without retry storms and is ready to add ETag-based conditional refreshes.

Cando o primeiro script se converte nun sistema real

Resolución de problemas e guía de produción

Usa estas guías cando unha resposta falla, non devolve datos ou precisa controles de produción como caché, tempos de espera, reintentos e entrega de eventos.

GuíaÚsao candoComezar
Diagnosticar unha resposta fallida ou vacía Separe os problemas de autenticación, acceso, ruta, límite de taxa e dispoñibilidade de datos sen expor a súa clave. Abrir guía →
Facer un cliente de API listo para produción Añada tempos de espera, reintentos limitados, caché, solicitudes condicionais e o patrón de entrega correcto. Abrir guía →