메인 콘텐츠로 건너뛰기

📘 Opensurvey API V3 전환 안내 (Changelog)

최소 6달 전에 업데이트됨
  • 📌V3 Release: 2025-03

  • 📅 V1·V2 Deprecation: 2026년 12월 종료 예정


🧨 주요 Breaking Change

설문 목록 조회 API

Endpoint: /v1/surveys → /v3/surveys

분류

항목

V1·V2

V3

변경

요청 쿼리 파라미터명

collectGroupsStatus

collectGroupStatus

nextSurveyId

offset

반환 필드 이름 및 형식

surveys
title

surveys
label

nextSurveyId

offset

추가

요청 쿼리 파라미터명

(기본: 한 번에 조회하는 개수 1000)

size

한 번에 조회할 개수 (별도로 지정하지 않으면 100, 최대 100)


설문 정보 조회 API

Endpoint: /v1/surveys/{surveyId} → /v3/surveys/{surveyId}

분류

항목

V1·V2

V3

변경

반환 필드 이름 및 형식

title

label

questions:

"questions": [
{
"rank": 1,
"type": "SingleChoice",
"text": "<p>거주하시는 집의 형태는 다음 중 어디에 해당하나요?</p>",
"options": [
{
"rank": 1,
"text": "<p>1번 보기</p>"
}
]
}
]

questions:

"questions": [
{
"name": "Q1",
"type": "SingleChoice",
"label": "<p>거주하시는 집의 형태는 다음 중 어디에 해당하나요?</p>",
"options": [
{
"name": "1",
"label": "<p>1번 보기</p>"
}
]
}
]

parameters:

"parameters": [
{
"parameterKey": "UID",
"isCollectable": true
}
]

embeddedData:

"embeddedData": [
{
"name": "parameter_UID",
"label": "응답자 고유 식별키"
}
]

추가

반환 필드 이름 및 형식

-

blocks:

"blocks": [
{
"name": "B1",
"label": "새 블록",
"questions": [
"Q1",
"Q2",
"Q3"
]
}
]

-

collectGroups:

"collectGroups": [
{
"collectGroupId": "a01h94kt4fyzmp64h40gzyvrjj7",
"label": "기본 링크 수집그룹",
"state": "READY"
}
]

수집그룹 목록 조회 API

Endpoint: /v1/surveys/{surveyId}/collect-groups → /v3/surveys/{surveyId}/collect-groups

분류

항목

V1·V2

V3

변경

반환 필드 이름 및 형식

name

label

제거

반환 필드 이름

targetCnt

(수집그룹 정보 조회 API에는 계속 존재)

startedAt

(수집그룹 정보 조회 API에는 계속 존재)

completedAt

(수집그룹 정보 조회 API에는 계속 존재)

createdAt

(수집그룹 정보 조회 API에는 계속 존재)

updatedAt

(수집그룹 정보 조회 API에는 계속 존재)


수집그룹 정보 조회 API

Endpoint: /v1/collect-groups/{collectGroupId} → /v3/collect-groups/{collectGroupId}

분류

항목

V1·V2

V3

변경

반환 필드 이름 및 형식

name

label

추가

반환 필드 이름 및 형식

-

links:

"links": [
"https://ds.fdback.me/r/aLLfXrjhIrTwt"
]

응답 URL 조회 API

Endpoint: /v1/collect-groups/{collectGroupId}/answer-urls → 제거

HMAC을 사용하시는 경우, 파라미터 수집 시 HMAC 서명 적용 가이드 문서에 따라 직접 구현해 주세요.


수집그룹 serial 값 조회 API

Endpoint: /v1/collect-groups/{collectGroupId}/serial → 제거

수집그룹 정보 조회 API에 추가된 links 필드를 사용해 주세요.


응답 조회 API

Endpoint: /v1/responses → /v3/surveys/{surveyId}/responses

분류

항목

V1·V2

V3

변경

요청 쿼리 파라미터명

pageToken

offset

반환 필드 이름 및 형식

pageToken

offset

responses

answers:

"answers": [
{
"name": "Q1",
"answer": [
{
"num": 6,
"str": "주관식 답변입니다."
}
]
}
]

responses

variables:

"variables": [
{
"name": "Q1",
"type": "MULTI_SELECT",
"label": "<p>좋아하는 것은?</p>",
"options": [
{
"value": "1",
"valueLabel": "<p>1번 보기</p>"
},
{
"value": "2",
"valueLabel": "<p>기타(직접 입력)</p>"
}
],
"answer": [
{
"value": "2",
"etcValue": "기타 응답입니다."
}
]
}
]

제거

요청 쿼리 파라미터명

surveyId

(Endpoint로 이동)

추가

요청 쿼리 파라미터명

(기본: 한 번에 조회하는 개수 1000)

size

한 번에 조회할 개수 (별도로 지정하지 않으면 1000, 최대 1000)

-

variables

-

embeddedData

반환 필드 이름 및 형식

-

responses

parameterUid

-

responses

responseId

-

responses

completedStatus

-

responses

embeddedData:

"embeddedData": [
{
"name": "parameter_UID",
"value": "xch123",
"valueLabel": "응답자 고유 식별키"
}
]

응답 메타데이터 조회 API

Endpoint: /v1/answer-sheets → /v3/surveys/{surveyId}/responses-meta

분류

항목

V1·V2

V3

변경

요청 쿼리 파라미터명

pageToken

offset

반환 필드 이름 및 형식

pageToken

offset

answerSheets

answerUid

responses

parameterUid

제거

요청 쿼리 파라미터명

surveyId

(Endpoint로 이동)

추가

요청 쿼리 파라미터명

(기본: 한 번에 조회하는 개수 1000)

size

한 번에 조회할 개수 (별도로 지정하지 않으면 1000, 최대 1000)

반환 필드 이름 및 형식

-

responses

responseId

-

responses

completedStatus

답변이 도움되었나요?