Skip to content

API GUIDE

Jump to bottom
K058_최재영 edited this page Oct 28, 2021 · 3 revisions

Travelog API GUIDE

관광정보 API

가이드 화면 / 여행 지역 선택 화면

  • 여행지역 전체 보기

    • 지역 목록 조회

      • BaseURL : http://api.visitkorea.or.kr/openapi/service/rest/KorService/areaCode?

      • Request Parameter

        numOfRows MobileOS MobileApp areaCode ServiceKey
        설명 페이지 당 결과수 OS 구분 서비스명 지역코드 인증키
        예시 100 AND Travelog 1 -
        • 지역 코드 입력 시 세부 지역 조회
        • ex) 1(서울) 입력 -> 금천구, 관악구 등 결과 출력

      • Response Message

        • resultMsg : OK (응답 확인)
        • body
          • code : 1 (지역 코드)
          • name : 서울 (지역명)

    • 지역 별 이미지 조회

      • BaseURL : http://api.visitkorea.or.kr/openapi/service/rest/KorService/areaBasedList?

      • Request Parameter

        numOfRows arrange MobileOS MobileApp areaCode sigunguCode ServiceKey
        설명 페이지 당 결과수 정렬구분 OS 구분 서비스명 지역코드 시군구코드 인증키
        예시 1 (최다 조회) P (조회순) AND Travelog 1 1 -
        • areaCode 1~8 (특별시, 광역시 등) -> 시군구 코드 입력 X
        • sigunguCode 입력 시 areaCode 필수

      • Response Message

        • resultMsg : OK (응답 확인)
        • body
          • firstimage : 이미지 URL

여행 지역별 화면 / 장소 검색 화면(검색어X)

  • BaseURL : http://api.visitkorea.or.kr/openapi/service/rest/KorService/areaBasedList?

  • Request Parameter

    numOfRows arrange MobileOS MobileApp contentTypeId areaCode sigunguCode ServiceKey
    설명 페이지 당 결과수 정렬구분 OS 구분 서비스명 관광타입ID 지역코드 시군구코드 인증키
    예시 1 (최다 조회) P (조회순) AND Travelog 12 (관광지) 1 1 -
    • 관광 타입마다 각 관광타입ID 입력
    • areaCode 1~8 (특별시, 광역시 등) -> 시군구 코드 입력 X
    • sigunguCode 입력 시 areaCode 필수

  • Response Message

    • resultMsg : OK (응답 확인)
    • body
      • firstimage2 : 썸네일 이미지 URL
      • title : 장소 제목

검색 화면

사용자가 API에서 관광지를 검색할 수 있다.

파라미터 numOfRows pageNo listYN arrange contentTypeId areaCode sigunguCode cat1 cat2 cat3 keyword
설명 한 페이지 결과 수 페이지 번호 목록 구분 정렬 구분 관광타입 ID 지역 코드 시군구 코드 대분류 중분류 소분류 요청 키워드
예시 10 1 Y (목록) D (생성일순) 12 (관광지, 숙박 등) 39 3 A04 A0401 A04010200 중앙시장
  • 응답 데이터
데이터 addr1 addr2 areacode contentid contenttypeid firstimage firstimage2 mapx mapy sigungucode tel title
설명 주소 상세주소 지역코드 콘텐츠ID 콘텐츠타입ID 이미지 썸네일 X좌표 Y좌표 시군구코드 전화번호 제목
예시 강원도 고성군 죽왕면 심층수길 124-19 (죽왕면) 32 2360786 12 이미지 원본 이미지 썸네일 128.5216381039 38.3343742648 2 033-638-9900 (주)강원심층수

코드 표

  • 지역 코드(areaCode)
지역 areaCode
서울 1
인천 2
대전 3
대구 4
광주 5
부산 6
울산 7
세종특별자치시 8
경기도 31
강원도 32
  • 관광 타입(ContentTypeId)
타입 종류 ContentTypeId
관광지 12
행사/공연/축제 14
음식점 39

지도 API

장소 정보 선택 후 화면 / 장소 정보 상세 화면 / 마커 클릭 시 화면

Google Maps Platform

변경 이력

  • 2021-10-25 18:18 최초 작성
  • 2021-10-27 11:05 Figma 기획서 링크 추가
  • 2021-10-28 13:39 개발 환경 별도 문서로 분리
Clone this wiki locally