본문으로 건너뛰기

API 워크플로우 가이드

무엇을 구축하고 싶으신가요?

귀하의 직무와 가장 유사한 결과를 선택하십시오. 각 경로는 하나의 작동하는 요청, 응답에 포함되어야 할 내용, 작동 여부 확인 방법 및 다음 유용한 단계를 제공합니다.

다섯 가지 실용적인 경로

종착점 목록이 아닌 결과부터 시작하십시오.

Selected: Harden a client

귀하의 14일 API 트라이얼

단순한 첫 요청을 넘어 지속 가능한 업무로 전환하세요.

목표는 모든 제품 페이지를 방문하는 것이 아닙니다. 유용한 인증된 API 작업을 완료하고, 다른 날에 돌아와서, 반복 가능한 데이터 세트나 애플리케이션 워크플로우를 가지고 떠나는 것입니다.

API 진행 상황 확인

0일

액세스 증명

키를 생성하고, 인증된 요청을 하나 완료한 다음, 첫 번째 응답을 메타데이터와 함께 저장하십시오.

단계 열기 →

일수 1-2

요청을 신뢰할 수 있게 만들기

인증 또는 필터 문제를 해결하고 첫 번째 스크립트를 이름이 지정된 반복 가능한 작업으로 전환하세요.

단계 열기 →

Day 3-4

출시 시점 추가

캘린더를 두 번째 엔드포인트 제품군으로 사용하고 다음 유용한 API 실행을 예약하십시오.

단계 열기 →

일 5-7

연구 결과물 구축

기대 사항이나 소규모 매크로 시리즈 그룹을 추가한 다음, 저장된 비교, 테이블 또는 스코어카드를 생성하십시오.

단계 열기 →

일수 8-10

업데이트 자동화

예약된 REST, SSE 또는 웹훅을 선택하고 다른 날에 또 다른 성공적인 API 실행을 완료하십시오.

단계 열기 →

일 11-13

클라이언트 강화

타임아웃, 제한된 재시도, 응답 검증, 자격 증명 안전 로깅 및 데이터 만료 모니터링을 추가하십시오.

단계 열기 →

14 일

증거 검토

API이 귀하의 팀이 계속 유지할 반복 가능한 작업을 제공하는지 확인한 다음, 다음 데이터 세트 또는 애플리케이션 워크플로우를 선택하십시오.

단계 열기 →

Production readiness

API 클라이언트를 프로덕션 준비 상태로 만들기

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 발표changesstreamwebhooks

작동 예시

키를 다음 위치에 보관하세요 FXMD_API_KEY; 소스 컨트롤에 절대 붙여넣지 마십시오.

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

예상 결과: A bounded client that handles transient failures without retry storms and is ready to add ETag-based conditional refreshes.

첫 번째 스크립트가 실제 시스템이 될 때

문제 해결 및 프로덕션 가이드

응답이 실패하거나, 데이터가 반환되지 않거나, 캐싱, 타임아웃, 재시도 및 이벤트 전달과 같은 프로덕션 제어가 필요한 경우 이 가이드를 사용하십시오.

가이드다음의 경우 사용하십시오시작
실패하거나 비어 있는 응답 진단 키를 노출하지 않고 인증, 액세스, 경로, 속도 제한 및 데이터 가용성 문제를 분리하여 해결하세요. 가이드 열기 →
API 클라이언트를 프로덕션 준비 상태로 만들기 타임아웃, 제한된 재시도, 캐싱, 조건부 요청 및 적절한 전달 패턴을 추가하십시오. 가이드 열기 →