백엔드
토스페이먼츠의 Open API 생태계
두줄요약
토스페이먼츠가 Open API를 장기 운영 관점에서 설계한 원칙과 지원 체계를 소개했습니다. 개발자 경험, 보안, 내부 표준화를 통해 안정성과 확장성을 함께 확보했습니다.
핵심 내용
- 토스페이먼츠 Open API를 수십 년간 안정적으로 운영하기 위한 설계·운영 원칙 정리
- 리소스 중심 인터페이스, 웹훅, 개발자 경험, 보안, 내부 조직 표준화로 구성된 5가지 핵심 요소 소개
- API 버저닝, 문서 자동화, 샌드박스, 로그 조회, 에러 재현, TLS와 암호화, Rate Limiting 등 실무 장치 설명
구조와 흐름
- 경로·요청·응답을 일관되게 설계해 예측 가능한 API 형태 유지
- API와 웹훅을 역할에 맞게 분리하고, 재전송과 이벤트 타입으로 비동기 처리 지원
- OAS 기반 문서화, 테스트 환경, 로그 조회, TAM 지원으로 외부 개발자 경험 강화
선택 이유
- 개발자가 코드 표를 외우지 않고도 이해할 수 있는 자연어 중심 데이터 표현 채택
- 기존 연동 영향 없이 진화하기 위해 버전별 API를 독립적으로 관리
- 내부 공통 라이브러리와 Committee로 조직 전반의 품질과 일관성 확보