링크 그룹 생성 API
단축 URL을 그룹 단위로 관리하기 위한 링크 그룹을 생성하는 API입니다.
생성된 그룹을 통해 여러 링크를 카테고리별로 분류하고, 설정을 일괄 적용하거나 효율적으로 관리할 수 있습니다.
링크 그룹을 활용하면 유효기간, 비밀번호, 웹훅, 클릭 제한 등 공통 설정을 그룹 단위로 일괄 적용할 수 있습니다.
개별 링크 설정과 그룹 설정이 중복될 경우 그룹 설정이 우선 적용됩니다.
POST
/api/link-group/v1/create
{
"nm": "Youtube Group",
"memo": "A group of links included in the description section of a YouTube video.",
"nonmemberSticsPwd": "123456"
}
Request Parameters
- nm string required
- 그룹 이름입니다. 링크를 분류하고 관리하기 위한 그룹의 이름을 설정합니다.
- memo string
- 그룹 관리용 메모입니다. 그룹의 목적이나 관리 정보를 자유롭게 기록할 수 있습니다.
- notfSubscYn string
- Default:N
-
Enum:
YN
-
푸시 구독 링크 여부를 설정합니다.
Y: 푸시 구독 전용 링크로 생성됩니다, N: 일반 링크로 생성됩니다.
푸시 구독 전용 링크는 사용자가 링크에 접속하면 웹 푸시 알림 구독 요청이 표시됩니다. - qrBypassYn string
- Default:N
-
Enum:
YN
-
QR 코드 접속 시 이동 방식 설정입니다.
Y: QR 코드 접속 시 원본 URL로 바로 이동합니다. (클릭 통계 미기록)
N: QR 코드 접속 시 짧은 링크 URL로 이동합니다. (클릭 통계 기록됨) - blockOverseasSticsYn string
- Default:N
-
Enum:
YN
-
해외 접속 통계 차단 여부를 설정합니다.
Y: 해외 접속은 통계에 포함되지 않습니다.
N: 모든 국가의 접속이 통계에 포함됩니다. - pushNotifyYn string
- Default:N
-
Enum:
YN
-
클릭 수 푸시 알림 여부를 설정합니다.
Y: 설정한 기준에 도달하면 푸시 알림이 전송됩니다.
N: 푸시 알림이 전송되지 않습니다.
이 기능은 퍼스널 요금제 이상에서만 제공됩니다. - mailNotifyYn string
- Default:N
-
Enum:
YN
-
클릭 수 이메일 알림 여부를 설정합니다.
Y: 설정한 기준에 도달하면 이메일 알림이 전송됩니다.
N: 이메일 알림이 전송되지 않습니다.
이 기능은 퍼스널 요금제 이상에서만 제공됩니다. - nonmemberSticsPwd string
-
비회원 클릭 수 조회 비밀번호입니다.
비회원 사용자에게 클릭 통계를 공개하려는 경우, 통계 페이지 접근 시 입력해야 하는 비밀번호를 설정합니다. - strtYmdt datetime
-
링크 유효기간 시작 날짜입니다.
설정한 날짜 이후부터 링크 접속이 허용됩니다.
예:2026-03-01 00:00:00 - endYmdt datetime
-
링크 유효기간 만료 날짜입니다.
설정한 날짜 이후에는 링크 접속이 차단됩니다.
예:
2026-03-31 23:59:59 - expireUrl string
-
링크 유효기간이 만료된 후 이동할 URL입니다.
설정하지 않으면 기본 안내 페이지가 표시됩니다.
예:https://example.com/event-expired - pwd string
-
링크 접근 비밀번호입니다.
설정된 경우 사용자는 링크 접속 시, 비밀번호를 입력해야 목적 페이지로 이동할 수 있습니다. - acesMaxCnt integer
-
최대 클릭 허용 횟수입니다.
설정한 횟수를 초과하면 링크 접속이 차단됩니다. (0값은 제한없음) - webhookEnableYn string
- Default:N
-
Enum:
YN
-
Webhook 사용 여부.
전역 Webhook이 활성화되어 있어야 합니다.
이 기능은 엔터프라이즈 요금제에서만 제공됩니다. - webhookCallbackUrl string
-
Webhook 이벤트를 수신할 서버 URL입니다.
webhookEnableYn값이Y일 때 필수 값이며, 사용자의 서버에서 이벤트 데이터를 수신할 엔드포인트를 입력합니다.
예:https://api.example.com/webhook - webhookMetric string
- Default:C
-
Enum:
CP
- Webhook 수신 기준. C:클릭 수 기준, P:사람 수 기준(고유 클릭 수)
- webhookFrequency integer
- Default:1
-
Enum:
1501002003005001000
- Webhook 수신 주기. 1:매번 클릭 시, 50:50회 마다, 100:100회 마다, 300:300회 마다, 500:500회 마다, 1000:1,000회 마다
{
"code": 0,
"message": "",
"result": {
"grpIdx": 5066, // group idx
"webhookSecretKey": null // When the ‘webhookEnableYn’ parameter is set to ‘Y’, a secret key is specified.
}
}
Response Parameters
- code integer
- 응답 코드: 0 = 성공, 그 외 값 = 오류
- message string
- 응답 메시지입니다. 응답 코드가 0이 아니면, 오류 관련 메시지가 반환됩니다.
- result object
- grpIdx integer
- 그룹 IDX.
- webhookSecretKey string
-
webhookEnableYn값이Y이면 secret key 값이 전달됩니다.
언제 이 API를 사용하나요?
다음과 같은 상황에서 링크 그룹 생성 API를 사용합니다.
- 여러 개의 단축 URL을 카테고리별로 관리할 때
- 마케팅 캠페인별 링크를 구분할 때
- 사용자 또는 프로젝트 단위로 링크를 분리할 때
- 그룹 단위 설정을 적용해야 할 때
링크 그룹의 역할
링크 그룹은 여러 단축 URL을 하나의 단위로 묶어 관리하는 기능입니다.
- 그룹별 링크 분류 및 관리
- 공통 설정 적용 (알림, 접근 제한 등)
- 데이터 분석 및 통계 구분
- 운영 및 관리 효율 향상
활용 예시
링크 그룹 생성 API는 다양한 환경에서 활용할 수 있습니다.
- 이벤트 페이지:
strtYmdt·endYmdt로 이벤트 기간만 접근 허용 - 내부 공유 링크:
pwd로 비밀번호를 걸어 외부 접근 차단 - 알림 연동 링크:
webhookCallbackUrl설정으로 클릭 발생 시 서버에 즉시 통보 - 기타: 쇼핑몰 상품 카테고리별 또는 고객·조직 단위 링크 분리
사용 시 주의사항
링크 그룹 생성 시 다음 사항을 확인하세요.
- 그룹 이름은 관리 목적에 맞게 명확하게 설정하세요
- 그룹 설정은 포함된 모든 링크에 영향을 줄 수 있습니다
- 잘못된 설정은 운영에 영향을 줄 수 있으므로 주의가 필요합니다
- 필요에 따라 그룹 수정 API를 함께 활용할 수 있습니다