요청 파라미터
이 문서는 Dataware API 연동 시 자주 사용하는 요청 요소를 빠르게 확인하기 위한 레퍼런스입니다.
공통 요청 요소
인증 헤더
승인된 계정에서 발급한 API 키를 Authorization 헤더에 포함합니다.
Authorization: Bearer YOUR_API_KEY
콘텐츠 타입
일반 JSON 요청은 아래 헤더를 사용합니다.
Content-Type: application/json
Accept: application/json
자주 사용하는 조회 파라미터
| 파라미터 | 예시 | 설명 |
|---|---|---|
page | 1 | 페이지 번호 |
limit | 20 | 페이지당 결과 수 |
q | farm | 이름 또는 설명 기반 검색 |
dataset | nolgofarm_experience_sites | dataset 범위 지정 |
status | active | 활성 상태 기준 조회 |
region_code | farm:275 | 지역 또는 소스 기준 코드 |
category_code | craft-cooking | 분류 코드 필터 |
실제 제공 파라미터는 dataset과 API 엔드포인트 범위에 따라 달라질 수 있습니다. 연동 전에는 대상 dataset의 상세 설명과 예시 호출을 함께 확인하는 것이 좋습니다.
Pagination
목록성 응답은 일반적으로 페이지네이션 구조를 함께 반환합니다.
{
"items": [],
"page": 1,
"limit": 20,
"total": 474
}
pagination 관련 체크 포인트
page와limit은 함께 사용하는 것을 권장합니다.- 너무 큰
limit보다 적절한 분할 조회가 안정적입니다. - 운영 화면과 API 호출 결과의 전체 개수는 시점에 따라 차이가 있을 수 있습니다.
상태 값 예시
dataset visibility
| 값 | 의미 |
|---|---|
public | 공개 카탈로그 기준으로 확인 가능 |
restricted | 승인 후 이용 |
paid | 계약 또는 유료 조건 기반 |
item status
| 값 | 의미 |
|---|---|
draft | 운영 준비 중 |
active | 제공 중 |
inactive | 현재 제공 중지 |
archived | 보관 상태 |
응답 필드에서 자주 보는 값
| 필드 | 설명 |
|---|---|
id | 내부 식별자 |
dataset_id | 소속 dataset 식별자 |
name | 레코드 이름 |
description | 상세 설명 |
category_code | 분류 코드 |
region_code | 지역 또는 출처 기준 코드 |
homepage_url | 외부 상세 링크 |
extra_attributes | dataset별 확장 속성 |