회원가입

외부 API 문서

외부 시스템에서 ODCH API를 사용하는 방법을 설명합니다.

기본 정보

  • Base URL: https://odch.postmedia.co.kr/api/external
  • 인증 방식: API Key (X-API-Key 헤더)
  • 응답 형식: JSON
  • 문자 인코딩: UTF-8
  • 파라미터 타입: OpenAPI Specification 3.0/3.1 의 타입으로 표기
    📖 OpenAPI 3.1 Data Types 참고

다중 사이트 지원 (2026-10)

POI·훼손정보 API는 siteNumber 쿼리 파라미터로 사이트를 지정할 수 있습니다. 생략 시 기존 호출과 동일하게 공산성으로 동작합니다(하위호환).

  • 공산성: siteNumber=1 (기본값, 생략 가능)
  • 마곡사: siteNumber=2
  • 전체 사이트 조회(GET 한정): siteNumber=all

POI 유형(poi-types)·훼손유형(damage-types) API는 전 사이트 공용 코드 테이블이라 siteNumber의 영향을 받지 않습니다.

사용 가능한 API

POI 유형 API

POI 유형 정보 조회

GET /poi-types

POI API

문화재 POI 정보 조회

GET /heritage-pois

훼손유형 API

훼손유형 정보 조회

GET /damage-types

훼손정보 API

문화재 훼손 정보 조회 및 생성

GET /damage-recordsPOST /damage-records

응답 형식

{
  "success": true,
  "data": [...],
  "pagination": {
    "totalDocs": 100,
    "totalPages": 10,
    "page": 1,
    "limit": 10,
    "hasNextPage": true,
    "hasPrevPage": false
  }
}