링크

주의사항
Expert level
API 키를 Authorization 헤더에 Bearer 토큰으로 전달해야 합니다.
API 키 발급받기
목록

API 엔드포인트:

GET
http://zxcv.be/api/v1/links

예제:

curl --location --request GET 'http://zxcv.be/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
파라미터
종류
설명
search
선택 string
검색 쿼리문.
by
선택 string
검색할 대상. 값으로 title, alias, url 를 사용할 수 있습니다. 기본값은 title 입니다.
status
선택 integer
상태 필터링. 값으로 0, 1, 2, 3 를 사용할 수 있습니다. 기본값은 0 입니다.
space
선택 integer
그룹ID 필터링.
domain
선택 integer
도메인ID 필터링.
pixel
선택 integer
픽셀ID 필터링.
sort
선택 string
정렬. 값으로 desc, asc, max, min 를 사용할 수 있습니다. 기본값은 desc 입니다.
per_page
선택 int
페이지당 출력 수. 값으로 10 to 100 를 사용할 수 있습니다. 기본값은 10 입니다.
확인

API 엔드포인트:

GET
http://zxcv.be/api/v1/links/{id}

예제:

curl --location --request GET 'http://zxcv.be/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
생성

API 엔드포인트:

POST
http://zxcv.be/api/v1/links

예제:

curl --location --request POST 'http://zxcv.be/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
파라미터
종류
설명
url
필수 string
The link to be shortened.
alias
선택 string
The link alias.
password
선택 string
The link password.
space
선택 integer
The space ID the link to be saved under.
domain
선택 integer
The domain ID the link to be saved under.
pixels
선택 array
The pixel IDs to be integrated in the link.
disabled
선택 integer
Whether the link is disabled or not. 값으로 0, 1 를 사용할 수 있습니다. 기본값은 0 입니다.
privacy
선택 integer
Whether the link stats are public or not. 값으로 0, 1, 2 를 사용할 수 있습니다. 기본값은 0 입니다.
privacy_password
선택 string
The password for the statistics page. Only works with privacy set to 2.
expiration_url
선택 string
The link where the user will be redirected once the link has expired.
expiration_date
선택 string
The link expiration date in YYYY-MM-DD format.
expiration_time
선택 string
The link expiration time in HH:MM format.
expiration_clicks
선택 integer
The number of clicks after which the link should expire.
target_type
선택 integer
The type of targeting. 값으로 0, 1, 2, 4 를 사용할 수 있습니다.
country[index][key]
선택 string
The code of the targeted country. The code must be in ISO 3166-1 alpha-2 standard.
country[index][value]
선택 string
The link where the user will be redirected to.
platform[index][key]
선택 string
The name of the targeted platform. 값으로 iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS 를 사용할 수 있습니다.
platform[index][value]
선택 string
The link where the user will be redirected to.
language[index][key]
선택 string
The code of the targeted language. The code must be in ISO 639-1 alpha-2 standard.
language[index][value]
선택 string
The link where the user will be redirected to.
rotation[index][value]
선택 string
The link where the user will be redirected to.
수정

API 엔드포인트:

PUT PATCH
http://zxcv.be/api/v1/links/{id}

예제:

curl --location --request PUT 'http://zxcv.be/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
파라미터
종류
설명
url
선택 string
The link to be shortened.
alias
선택 string
The link alias.
password
선택 string
The link password.
space
선택 integer
The space ID the link to be saved under.
domain
선택 integer
The domain ID the link to be saved under.
pixels
선택 array
The pixel IDs to be integrated in the link.
disabled
선택 integer
Whether the link is disabled or not. 값으로 0, 1 를 사용할 수 있습니다.
privacy
선택 integer
Whether the link stats are public or not. 값으로 0, 1, 2 를 사용할 수 있습니다.
privacy_password
선택 string
The password for the statistics page. Only works with privacy set to 2.
expiration_url
선택 string
The link where the user will be redirected once the link has expired.
expiration_date
선택 string
The link expiration date in YYYY-MM-DD format.
expiration_time
선택 string
The link expiration time in HH:MM format.
expiration_clicks
선택 integer
The number of clicks after which the link should expire.
target_type
선택 integer
The type of targeting. 값으로 0, 1, 2, 4 를 사용할 수 있습니다.
country[index][key]
선택 string
The code of the targeted country. The code must be in ISO 3166-1 alpha-2 standard.
country[index][value]
선택 string
The link where the user will be redirected to.
platform[index][key]
선택 string
The name of the targeted platform. 값으로 iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS 를 사용할 수 있습니다.
platform[index][value]
선택 string
The link where the user will be redirected to.
language[index][key]
선택 string
The code of the targeted language. The code must be in ISO 639-1 alpha-2 standard.
language[index][value]
선택 string
The link where the user will be redirected to.
rotation[index][value]
선택 string
The link where the user will be redirected to.
삭제

API 엔드포인트:

DELETE
http://zxcv.be/links/{id}/destroy

예제:

curl --location --request DELETE 'http://zxcv.be/links/{id}/destroy' \
--header 'Authorization: Bearer {api_key}'