Sparse spatial map APIs 오류 코드 설명

응답 형식

모든 API 응답은 통일된 JSON 형식을 사용합니다. 다음은 예시입니다:

{

  "statusCode": 119,

  "msg": "Parameter has errors",

  "date": "2022-06-15T09:56:30.000Z",

  "result":  //statusCode가 0일 때만 result가 있으며, 오류가 발생하면 결과 필드는 비어 있습니다

}

필드	타입	설명
statusCode	integer	비즈니스 status code. 0은 성공을 의미하고, 0이 아니면 오류를 의미합니다
msg	string	메시지
result	object	반환 내용. status code가 0일 때 target image object structure로 응답하며, 그렇지 않으면 비어 있습니다
date	string	서버 시간

중요

statusCode == 0 조건에서만 result에 응답 내용이 포함됩니다. 다른 상태에서는 result가 비어 있습니다
statusCode != 0 조건에서는 오류 메시지 msg에 주의하십시오

오류 코드 분류

HTTP status code 설명

HTTP status code	설명
200	요청 성공(비즈니스 오류를 포함할 수 있음)
400	요청 parameter 오류
401	APIKey 인증 실패
403	권한 부족 또는 resource 접근 금지
404	요청 URL API Path가 존재하지 않음
500	서버 내부 오류
502	애플리케이션 exception capture, data 오류 가능

주의: 비즈니스 오류는 일반적으로 HTTP 200 응답으로 반환되며, 구체적인 오류 유형은 statusCode 필드에서 식별됩니다.

Business status code 일람표

Status Code	Message
0	Success
101	Uploaded file is empty
102	File size is too large
106	Missing parameter or parameter is empty
110	Call server API errors
111	Resource not found
401	Authentication token expired
401	Authentication parameter is missing
401	Unknown appId or appKey
401	Account is locked
401	Authentication failed, invalid signature or token

일반적인 오류 시나리오

Timeout 무응답

Request Timeout: 네트워크가 비교적 느립니다. client의 네트워크 환경을 확인하는 것이 좋습니다

인증 관련 오류

Http 401 Unauthorized: APIKey 인증 실패. appId/appKey가 올바른지 확인하십시오
Status code 401: application key가 유효하지 않거나 application이 존재하지 않습니다. application 구성을 확인하십시오

Parameter 오류

400 Bad Request: 요청 parameter 형식 오류

Resource 작업 오류

Status code 10x: 조회한 target resource가 존재하지 않거나 parameter가 잘못되었습니다

시스템 오류

Http 50x Internal Server Error: 서버 내부 exception 또는 application exception capture. 웹사이트나 sample에서 테스트하는 것이 좋습니다

모범 사례 권장 사항

client 처리: HTTP status code에만 의존하지 말고 statusCode 필드를 기준으로 비즈니스 성공 여부를 판단하는 것이 좋습니다
오류 retry: 5xx 오류는 적절히 retry할 수 있으며, 4xx 오류는 요청 parameter를 확인해야 합니다
로그 기록: 문제 해결을 위해 전체 오류 응답을 기록하는 것이 좋습니다
Timeout 처리: 오래 기다리는 것을 피하기 위해 합리적인 요청 timeout 시간을 설정합니다

Table of Contents