마지막 수정:
Click to expand / collapse
강력한 API 통합은 속도뿐만 아니라 충돌 동작의 예측 가능성에 따라 구축됩니다. 각 파트너가 모든 환경에서 시스템에서 무엇을 기대해야하는지 알 수 있도록 완전한 오류 코드 문서와 SLA (Service Level Agreement) 보증을 제공합니다.
이를 통해 중요한 시나리오에서도 아키텍처 계획, 강력한 코드 작성 및 신뢰 통합에 도움이됩니다
SLA 및 오류 문서에 포함 된 내용
| 섹션 | 포함 된 것 |
|---|---|
| SLA 지표 | 가동 시간, 평균 응답 시간, 오류 수 허용 |
| 임시 규정 | 최대 응답 시간 및 사고 해결 |
| 오류 코드 (HTP 상태) | 4xx/5xx 코드의 해독, 처리 권장 사항 |
| 응답 기관의 오류 | JSON 오류 형식, 필드 '코드', '메시지', '세부 사항' |
| 오류 처리의 예 | 401, 403, 429, 500 및 기타 오류 처리의 예 |
| 시간 초과 동작 | 한계를 초과하거나 API를 사용할 수 없을 때해야 할 일 |
기업과 개발자가 필요로하는 이유는 무엇입니까?
API 안정성에 대한 자신감
실패의 원인을 빠르게 정확히 찾아냅니
지원 부담 감소
클라이언트 코드에서 오류 처리 자동화
부하 및 사고에 대한 명확한 시스템 기대
우리가 구현하는 방
오류 코드에 대한 문서 게시 (Swagger, Redoc, Markdown)
개발자 포털에서 SLA의 별도 섹션
Prometheus, Datadog, UptimeRobot을 통한 SLA 지표 설정
경고 및 모니터링과의 통합
SLA 트리거 및 티켓 시스템을 통한 사고 지원
특히 중요한 곳
금융 및 보험 서비스
미션 크리티컬 모바일 앱
클라이언트가 많은 B2B 플랫폼
SLA 의무가있는 공개 API