링크
참고
전문가 수준
API 키는 요청의 권한 부여 헤더에 베어러 토큰으로 전송되어야 합니다. API 키 받기.
목록
API 엔드포인트:
GET
https://goo.vc/api/v1/links?ko
요청 예시:
curl --location --request GET 'https://goo.vc/api/v1/links?ko' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
매개변수
유형
설명
search선택 사항 string
검색 쿼리입니다.
search_by선택 사항 string
검색 기준. 가능한 값은 다음과 같습니다: 제목의 경우
title, Alias의 경우 alias, URL의 경우 url. 기본값은 title.status선택 사항 integer
상태별로 필터링합니다. 가능한 값은 다음과 같습니다: 모두의 경우
0, 활성의 경우 1, 만료됨의 경우 2, 장애인의 경우 3. 기본값은 0.space_id선택 사항 integer
스페이스 ID로 필터링합니다.
domain_id선택 사항 integer
도메인 ID로 필터링합니다.
pixel_id선택 사항 integer
픽셀 ID로 필터링합니다.
sort_by선택 사항 string
정렬 기준. 가능한 값은 다음과 같습니다: 생성 날짜의 경우
id, 클릭 수의 경우 clicks, 제목의 경우 title, Alias의 경우 alias, URL의 경우 url. 기본값은 id.sort선택 사항 string
정렬. 가능한 값은 다음과 같습니다: 내림차순의 경우
desc, 오름차순의 경우 asc. 기본값은 desc.per_page선택 사항 integer
페이지당 결과. 가능한 값은 다음과 같습니다:
10, 25, 50, 100. 기본값은 10.표시
API 엔드포인트:
GET
https://goo.vc/api/v1/links/{id}?ko
요청 예시:
curl --location --request GET 'https://goo.vc/api/v1/links/{id}?ko' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {api_key}'
스토어
API 엔드포인트:
POST
https://goo.vc/api/v1/links?ko
요청 예시:
curl --location --request POST 'https://goo.vc/api/v1/links?ko' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer {api_key}' \ --data-urlencode 'url={url}' \ --data-urlencode 'domain={id}'
매개변수
유형
설명
url필수 string
단축할 링크입니다.
domain_id필수 integer
링크를 저장할 도메인 ID입니다.
alias선택 사항 string
링크 별칭입니다.
password선택 사항 string
링크 비밀번호입니다.
space_id선택 사항 integer
링크를 저장할 공간 ID입니다.
pixel_ids선택 사항 array
The pixel IDs to be integrated in the link.
disabled선택 사항 integer
링크가 비활성화되어 있는지 여부. 가능한 값은 다음과 같습니다: 활성의 경우
0, 장애인의 경우 1. 기본값은 0.privacy선택 사항 integer
링크 통계의 공개 여부. 가능한 값은 다음과 같습니다: 공개의 경우
0, 비공개의 경우 1, 비밀번호의 경우 2. 기본값은 0.privacy_password선택 사항 string
통계 페이지의 비밀번호입니다.
privacy을 2로 설정한 경우에만 작동합니다.expiration_url선택 사항 string
링크가 만료된 후 사용자가 리디렉션될 링크입니다.
expiration_date선택 사항 string
링크 만료일(
YYYY-MM-DD 형식)입니다.expiration_time선택 사항 string
링크 만료 시간(
HH:MM 형식)입니다.expiration_clicks선택 사항 integer
링크가 만료되는 클릭 횟수입니다.
target_type선택 사항 integer
타겟팅 유형입니다. 가능한 값은 다음과 같습니다: 없음의 경우
0, 지리적의 경우 1, 플랫폼의 경우 2, 회전의 경우 4.country[index][value]선택 사항 string
사용자가 리디렉션될 링크입니다.
platform[index][key]선택 사항 string
타겟팅 플랫폼의 이름입니다. 가능한 값은 다음과 같습니다:
iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.platform[index][value]선택 사항 string
사용자가 리디렉션될 링크입니다.
language[index][value]선택 사항 string
사용자가 리디렉션될 링크입니다.
rotation[index][value]선택 사항 string
사용자가 리디렉션될 링크입니다.
업데이트
API 엔드포인트:
PUT PATCH
https://goo.vc/api/v1/links/{id}?ko
요청 예시:
curl --location --request PUT 'https://goo.vc/api/v1/links/{id}?ko' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer {api_key}' \ --data-urlencode 'url={url}'
매개변수
유형
설명
url선택 사항 string
단축할 링크입니다.
alias선택 사항 string
링크 별칭입니다.
password선택 사항 string
링크 비밀번호입니다.
space_id선택 사항 integer
링크를 저장할 공간 ID입니다.
pixel_ids선택 사항 array
The pixel IDs to be integrated in the link.
disabled선택 사항 integer
링크가 비활성화되어 있는지 여부. 가능한 값은 다음과 같습니다: 활성의 경우
0, 장애인의 경우 1.privacy선택 사항 integer
링크 통계의 공개 여부. 가능한 값은 다음과 같습니다: 공개의 경우
0, 비공개의 경우 1, 비밀번호의 경우 2.privacy_password선택 사항 string
통계 페이지의 비밀번호입니다.
privacy을 2로 설정한 경우에만 작동합니다.expiration_url선택 사항 string
링크가 만료된 후 사용자가 리디렉션될 링크입니다.
expiration_date선택 사항 string
링크 만료일(
YYYY-MM-DD 형식)입니다.expiration_time선택 사항 string
링크 만료 시간(
HH:MM 형식)입니다.expiration_clicks선택 사항 integer
링크가 만료되는 클릭 횟수입니다.
target_type선택 사항 integer
타겟팅 유형입니다. 가능한 값은 다음과 같습니다: 없음의 경우
0, 지리적의 경우 1, 플랫폼의 경우 2, 회전의 경우 4.country[index][value]선택 사항 string
사용자가 리디렉션될 링크입니다.
platform[index][key]선택 사항 string
타겟팅 플랫폼의 이름입니다. 가능한 값은 다음과 같습니다:
iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.platform[index][value]선택 사항 string
사용자가 리디렉션될 링크입니다.
language[index][value]선택 사항 string
사용자가 리디렉션될 링크입니다.
rotation[index][value]선택 사항 string
사용자가 리디렉션될 링크입니다.
삭제
API 엔드포인트:
DELETE
https://goo.vc/api/v1/links/{id}?ko
요청 예시:
curl --location --request DELETE 'https://goo.vc/api/v1/links/{id}?ko' \ --header 'Authorization: Bearer {api_key}'
