문서 / API 오류

API 오류 처리

iGaming 통합을 위한 응답, 오류 코드, 일시적 장애, 결과 불명, 진단 및 안전한 복구의 통합 모델.

테스트 보기
HTTP
요청 결과
코드
명확한 원인
재시도
안전한 조치
추적
요청 진단
오류 처리 주기

API 응답부터 복구까지

01
결과 유형 확인

HTTP 상태, 원인 코드, 오류 범주 및 처리 상태를 확인합니다.

02
분석용 데이터 저장

요청 및 처리 식별자, 엔드포인트, 시간, 제공업체 참조값 및 안전한 매개변수를 기록합니다.

03
안전한 조치 선택

데이터를 수정하거나 처리를 중단하고, 지연 후 재시도하거나 현재 상태를 확인합니다.

04
복구 및 검증

중복을 방지하고 결과를 대사하며 담당 팀에 알리고 근본 원인을 해소합니다.

개요

오류는 원인과 다음 조치를 설명해야 합니다

HTTP 400 또는 500 응답만으로는 충분하지 않습니다. 신뢰할 수 있는 API는 안정적인 원인 코드를 반환하고 응답을 요청 식별자와 연결하며, 데이터를 수정해야 하는지, 처리를 중단해야 하는지, 요청을 재시도해야 하는지 또는 상태를 별도로 확인해야 하는지 알 수 있게 해야 합니다.

안정적인 원인 코드

안정적인 오류 코드는 클라이언트 로직, 보고 및 문의 자동 분류에 사용됩니다.

예측 가능한 조치

오류 범주는 요청을 재시도할 수 있는지와 어떤 데이터를 변경해야 하는지 알려 줍니다.

진단 연계

요청, 처리 및 제공업체 식별자는 클라이언트 로그를 내부 시스템 및 지원과 연결합니다.

오류 구조

권장 오류 응답 구조

응답은 내부 구현이나 민감 정보를 노출하지 않으면서 자동 처리에 적합하도록 간결하고 안정적이어야 합니다.

오류 코드

설명 메시지가 수정되어도 바뀌지 않는 원인의 안정적인 식별자입니다.

설명

내부 코드, 데이터베이스 쿼리, 비밀 정보 또는 불필요한 세부사항을 포함하지 않는 짧고 안전한 설명입니다.

요청 ID

로그에서 처리를 찾고 지원팀에 문의하기 위한 고유 식별자입니다.

추가 데이터

허용 상태, 한도, 현재 상태 또는 안전한 거절 사유입니다.

재시도 가능

처리의 중복 방지 기능을 해제하지 않는 일시적 오류임을 명확히 나타냅니다.

재시도 전 대기

요청 빈도 제한 및 일시적 이용 불가 상황을 위한 권장 지연 시간(초) 또는 HTTP 헤더입니다.

필드 오류

원인 코드, 값 경로 및 안전한 설명이 포함된 문제 필드 목록입니다.

문서 참조

원인과 해결 방법을 설명하는 영구 링크 또는 섹션 식별자입니다.

오류 범주

주요 오류 범주

HTTP 상태는 일반적인 결과 범주를 나타내고 내부 코드는 구체적인 원인과 허용되는 조치를 식별합니다.

입력값 검증 오류

잘못된 형식, 필수 필드 누락, 지원되지 않는 값, 금액 정밀도 오류 또는 잘못된 요청 구조.

인증 오류

누락되었거나 만료되었거나 유효하지 않은 토큰, API 키, 서명, 요청 타임스탬프 또는 nonce.

권한 부족

클라이언트는 인식되지만 해당 작업에 필요한 역할, 브랜드, 시장 또는 권한이 없습니다.

객체를 찾을 수 없음

플레이어, 결제, 라운드, KYC 확인, 제공업체 또는 기타 객체가 존재하지 않거나 클라이언트가 접근할 수 없습니다.

상태 충돌

객체의 버전이나 상태가 변경되었거나 처리 식별자가 이미 다른 매개변수와 함께 사용되었습니다.

비즈니스 규칙 위반

잔액 부족, 한도 초과, 차단된 플레이어, 금지된 시장 또는 허용되지 않는 상태 전환.

요청이 너무 많음

클라이언트, 메서드, 역할 또는 중요 처리에 허용된 요청 수를 초과했습니다.

제공업체 이용 불가

외부 서비스를 이용할 수 없거나 응답이 느리거나 일시적으로 처리를 받지 않습니다.

내부 오류

내부 세부사항을 노출하지 않으면서 진단용 식별자를 포함하는 예기치 않은 플랫폼 오류입니다.

재시도 및 복구

요청 재시도 및 결과 불명

재시도는 오류 유형을 확인하고 원래 처리가 이미 완료되었을 가능성을 검토한 후에만 안전합니다.

01

재시도 허용 여부 확인

데이터, 권한 및 비즈니스 규칙 오류는 일반적으로 재전송이 아니라 요청 수정이 필요합니다.

02

동일한 처리 키 유지

금융, 게임 또는 기타 중요 처리를 재시도해도 새로운 결과가 생성되어서는 안 됩니다.

03

시도 간 대기 시간 증가

간격을 점진적으로 늘리고 서버가 지정한 대기 시간을 따르며 전체 시도 횟수를 제한합니다.

04

중단 후 검토로 에스컬레이션

모든 시도를 소진하면 처리를 미완료 상태로 기록하고 수동 검토 또는 대사로 넘깁니다.

응답이 없다고 해서 처리가 실패한 것은 아닙니다

요청 전송 후 연결이 끊기면 결과가 불명확할 수 있습니다. 재시도 전에 처리 식별자로 상태를 확인하거나 신뢰할 수 있는 알림을 기다려야 합니다.

진단 및 제어

로그, 식별자, 지표 및 알림

진단은 불필요한 민감 데이터를 저장하지 않으면서 플랫폼, 어댑터 및 외부 제공업체 사이의 요청 경로를 재구성할 수 있어야 합니다.

분석 컨텍스트

요청, 상관관계, 처리 및 외부 제공업체 식별자.
엔드포인트, HTTP 메서드, 환경, 클라이언트, 시간 및 응답 소요 시간.
HTTP 상태, 오류 코드, 시도 횟수 및 최종 상태.
마스킹된 민감 필드, 안전한 헤더 및 서명 검증 결과.

모니터링 및 알림

메서드, 제공업체, 클라이언트 및 원인 범주별 오류율.
느린 응답, HTTP 5xx 오류, 잘못된 서명 및 요청 빈도 제한 이벤트 증가.
재시도 횟수, 결과가 불명확한 처리 수 및 복구 작업 수.
임계값, 담당자 및 에스컬레이션 규칙이 포함된 알림.
테스트

테스트 환경에서 확인할 항목

테스트 환경은 주요 오류 범주를 모두 재현하고 클라이언트, 재시도 및 제어 동작이 올바른지 확인할 수 있어야 합니다.

입력값 검증 오류

필드 누락, 잘못된 유형, 지원되지 않는 값, 금액 정밀도 및 여러 오류의 동시 발생.

접근 및 권한

잘못된 키, 만료된 토큰, 잘못된 서명, 권한 없는 역할, 차단된 IP 및 재사용된 nonce.

응답 없음 및 결과 불명

전송 전 연결 실패, 처리 접수 후 연결 실패 및 최종 응답 수신 중 연결 실패.

요청 빈도 제한

HTTP 429, 권장 대기 시간, 동시 요청 및 제한 종료 후 복구.

제공업체 오류

이용 불가, 유지보수, 잘못된 응답, 지연된 알림 및 상충되는 상태.

재시도 및 보호 중단

시도 횟수 제한, 대기 시간 증가, 요청의 일시 중단, 통제된 복구 및 수동 에스컬레이션.

출시 전 체크리스트

오류 구조, 클라이언트 동작, 중복 방지 및 진단을 검증한 후 운영 통합을 시작합니다.

모든 오류는 안정적인 원인 코드와 요청 식별자를 반환합니다.
오류 세부정보에 비밀 정보나 내부 구현이 노출되지 않습니다.
일시적 오류와 영구 오류 범주가 문서화되어 있습니다.
중요 처리를 재시도할 때 동일한 멱등성 키를 사용합니다.
결과가 불명확한 경우 상태 확인 또는 신뢰할 수 있는 알림으로 처리합니다.
로그, 지표, 알림, 복구 큐 및 에스컬레이션 규칙이 구성되어 있습니다.

API 오류를 표준화해야 하나요?

현재 HTTP 응답, 오류 코드, 재시도 규칙 및 문제 시나리오를 보내 주세요. APIACE가 통합 오류 모델, 안전한 복구 및 제어 방식을 정의하도록 지원합니다.