문서

응답 코드

Singular의 API와 연동할 때 모든 응답은 HTTP 200 상태 코드를 반환하며, 응답 본문의 '상태' 필드의 유효성을 검사하여 성공('ok') 또는 실패('error')를 확인해야 합니다.

응답 페이로드에는 상태가'오류'인 경우 자세한 오류 정보를 제공하는'이유' 필드가 포함됩니다.

잘못된 매개변수와 같이 재시도할 수 없는 오류를 제외하고 구성 가능한 최대 시도 횟수를 사용하여 지수적 백오프 재시도 메커니즘을 구현하세요.
데이터 일관성을 보장하기 위해 재시도 중 요청 순서를 유지합니다.
적절한 디버깅 및 모니터링을 위해 원본 매개변수, 오류 메시지, 디바이스 식별자, 타임스탬프 등 모든 실패한 요청을 기록하세요. 재시도 시도를 추적하고 중대한 실패에 대한 알림 시스템을 구현하세요. 오류 응답 형식은 상태 및 이유 필드가 포함된 일관된 JSON 구조를 따릅니다.

이러한 포괄적인 오류 처리 전략은 데이터 정확성을 유지하고 잠재적인 문제에 대한 명확한 가시성을 제공하면서 강력한 API 연동을 보장합니다.

성공

다음은 요청에 대한 성공적인 API 응답을 나타냅니다.

HTTP 응답

200 - ok

응답 본문에 오류나 이유 없이 200 - 확인이 표시되면 요청이 처리를 위해 대기열로 전송되었음을 의미합니다.

응답:

{
    "status": "ok"
}

다음은 API가 요청에 대한 응답으로 반환할 수 있는 오류 메시지입니다.

HTTP 응답
`200 - error`	200 - '이유'가 "인수가 누락되었습니다: {param}". 이 오류는 모든 필수 매개변수가 아닌 특정 매개변수에 대해서만 발생합니다. 매개변수가 누락되었거나 값이 누락된 경우 인수 누락 오류가 발생할 수 있습니다. 오류를 해결하고 요청을 다시 보내야 합니다. 응답: `{ "status": "error", "reason": "missing argument: a" }`
`200 - error`	200 - '이유'가 "잘못된 플랫폼: {플랫폼}". 이는 플랫폼 값이 유효하지 않음을 의미합니다. 오류를 해결하고 요청을 다시 보내야 합니다. 응답: `{ "status": "error", "reason": "invalid platform: Desktop" }`
`200 - error`	200 - '이유'가 "제공된 디바이스 ID 없음"인 오류 응답 코드입니다. 요청에 디바이스 식별자가 포함되지 않았습니다. 오류를 해결하고 요청을 다시 보내야 합니다. 응답: `{ "status": "error", "reason": "no device ID supplied" }`
`200 - error`	200 - 오류 응답 코드(이유: "플랫폼: {플랫폼}에 {식별자} 매개변수가 있어야 합니다."입니다. 이 오류는 지정된 플랫폼에 올바른 디바이스 식별자가 없다는 의미입니다. 오류를 해결하고 요청을 다시 보내야 합니다. 응답: `{ "status": "error", "reason": "platform: PC should have an sdid param" }`
`XXX`	200 - 확인을 받지 못한 경우 요청을 다시 시도해야 합니다.