다크 모드
레퍼런스
도보 길찾기 API에서 사용하는 공통 클래스 정보를 안내합니다.
공통 에러 코드
다음은 API 제품별로 발생할 수 있는 에러 코드 정보입니다. 에러 발생 시 code 중 해당하는 항목을 찾아 원인을 파악할 수 있습니다.
예제 응답 (예기치 못한 서버 오류 발생 시):
json
{
"code": -1,
"msg": "internal server error"
}일반적인 탐색 실패가 아닌 서버 오류나 사용자 입력 오류가 발생한 경우, 위와 같은 JSON 형식으로 응답이 전달됩니다.
| Code | HTTP status code | Description |
|---|---|---|
| -1 | 500 | 서버 내부에서 처리 중에 에러가 발생한 경우 해결 방법: 재시도 |
| -2 | 400 | 필수 인자가 포함되지 않은 경우나 호출 인자 값의 데이터 타입이 적절하지 않거나 허용된 범위를 벗어난 경우 해결 방법: 요청 파라미터 확인 |
| -3 | 403 | 해당 API를 사용하기 위해 필요한 기능(간편 가입, 동의 항목, 서비스 설정 등)이 활성화되지 않은 경우 해결 방법: 카카오디벨로퍼스의 내 애플리케이션에서 필요한 기능을 선택한 후, [활성화 설정]에서 ON으로 설정한 후 재호출 |
| -4 | 403 | 계정이 제재된 경우나 해당 계정에 제재된 행동을 하는 경우 |
| -5 | 403 | 해당 API에 대한 요청 권한이 없는 경우 해결 방법: 검수 진행하여 권한 획득 후 재호출 |
| -7 | 500 | 서비스 점검 또는 내부 문제가 있는 경우 |
| -8 | 400 | 올바르지 않은 헤더로 요청한 경우 해결 방법: 요청 헤더 확인 |
| -9 | 400 | 서비스가 종료된 API를 호출한 경우 |
| -10 | 400 | 허용된 요청 회수가 초과한 경우 해결 방법: 허용된 쿼터 확인 후 쿼터 범위 내로 호출 조정, 쿼터 및 제한 참고 |
| -401 | 401 | 유효하지 않은 앱 키나 액세스 토큰으로 요청한 경우, 등록된 앱 정보와 호출된 앱 정보가 불일치하는 경우 해결 방법: 앱 키(App Key) 확인 또는 토큰 갱신, 개발자 사이트에 등록된 앱 정보 확인 |
| -602 | 400 | 이미지 업로드 시 최대 용량을 초과하였을 경우 |
| -603 | 400 | 이미지 업로드나 스크랩 요청과 같이 오래 걸리는 작업이 필요한 API에서 수행 시간이 오래 걸리는 경우 |
| -903 | 400 | 등록되지 않은 개발자의 앱 키나 등록되지 않은 개발자의 앱 키로 구성된 액세스 토큰으로 요청한 경우 |
| -911 | 400 | 지원하지 않는 포맷의 이미지를 업로드하는 경우 |
| -9798 | 503 | 서비스 점검 중 |
result_code: 경로 탐색 결과 코드
표 1 | 경로 탐색 결과 코드
| Code | Description |
|---|---|
| 0 | 길찾기 성공 |
| 1 | 길찾기 결과를 찾을 수 없음 |
| 101, -2 | 출발지 주변의 도로를 탐색할 수 없음 |
| 102, -2 | 도착지 주변의 도로를 탐색할 수 없음 |
| 103, -2 | 경유지 주변의 도로를 탐색할 수 없음 |
| 104 | 출발지/목적지/경유지 지점을 연결할 수 있는 도로가 없음. 이는 주로 섬과 섬, 또는 섬과 육지의 탐색일 경우 발생하며, 각 지점을 연결하는 다리가 있는 경우는 제외함. |
| 105 | 섹션 간 직선 거리가 50 km를 벗어남 |
| 203 | 다중 탐색(Multipoint): 요청한 탐색 반경을 초과 |
| 204 | 다중 탐색(Multipoint): 요청한 최대 결과 개수를 초과 |