외부 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 참고

사용 가능한 API

POI 유형 API

POI 유형 정보 조회

GET /poi-types

POI API

문화재 POI 정보 조회

GET /heritage-pois

훼손유형 API

훼손유형 정보 조회

GET /damage-types

훼손정보 API

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

GET /damage-recordsPOST /damage-records

측정정보 API

환경 측정 데이터 조회 및 생성

GET /measurement-valuesPOST /measurement-values

⚠️ 데이터 구조 미확정

응답 형식

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