링크

참고
전문가 수준
The API key should be sent as a Bearer token in the Authorization header of the request. API 키 가져오기.
목록

API endpoint:

GET
https://ppomo.cc/api/v1/links

요청 예제:

curl --location --request GET 'https://ppomo.cc/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
유형
설명
search
선택사항 string
검색 쿼리
by
선택사항 string
Search by. 가능한 값은: title for 제목, alias for 별칭, url for URL.
status
선택사항 integer
Filter by status. 가능한 값은: 0 for All, 1 for 활성, 2 for Expired, 3 for 비활성.
space
선택사항 integer
Filter by space id.
domain
선택사항 integer
Filter by domain id.
sort
선택사항 string
Sort by. 가능한 값은: desc for 내림차순, asc for 오름차순, max for Best performing, min for Least performing.
Show

API endpoint:

GET
https://ppomo.cc/api/v1/links/{id}

요청 예제:

curl --location --request GET 'https://ppomo.cc/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

API endpoint:

POST
https://ppomo.cc/api/v1/links

요청 예제:

curl --location --request POST 'https://ppomo.cc/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
유형
설명
url
필수 string
The link to be shortened.
alias
선택사항 string
링크 별칭
password
선택사항 string
링크 비밀번호
space
선택사항 integer
The space id the link to be saved under.
domain
선택사항 integer
The domain id the link to be saved under.
disabled
선택사항 integer
Whether the link is disabled or not. 기본값: 0.
public
선택사항 integer
Whether the link stats are public or not. 기본값: 0.
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
링크가 만료된 후 클릭 수.
target_type
선택사항 integer
타겟팅 유형. 가능한 값은: 0 for None, 1 for Geographic, 2 for 플랫폼, 3 for Rotation.
geo[index][key]
선택사항 string
The code of the targeted country. The code must be in ISO 3166-1 alpha-2 standard.
geo[index][value]
선택사항 string
The country 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 platform link where the user will be redirected to.
rotation[index][value]
선택사항 string
The rotation link where the user will be redirected to.
업데이트

API endpoint:

PUT PATCH
https://ppomo.cc/api/v1/links/{id}

요청 예제:

curl --location --request PUT 'https://ppomo.cc/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
유형
설명
url
선택사항 string
The link to be shortened.
alias
선택사항 string
링크 별칭
password
선택사항 string
링크 비밀번호
space
선택사항 integer
The space id the link to be saved under.
domain
선택사항 integer
The domain id the link to be saved under.
disabled
선택사항 integer
Whether the link is disabled or not. 기본값: 0.
public
선택사항 integer
Whether the link stats are public or not. 기본값: 0.
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
링크가 만료된 후 클릭 수.
target_type
선택사항 integer
타겟팅 유형. 가능한 값은: 0 for None, 1 for Geographic, 2 for 플랫폼, 3 for Rotation.
geo[index][key]
선택사항 string
The code of the targeted country. The code must be in ISO 3166-1 alpha-2 standard.
geo[index][value]
선택사항 string
The country 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 platform link where the user will be redirected to.
rotation[index][value]
선택사항 string
The rotation link where the user will be redirected to.
삭제

API endpoint:

DELETE
https://ppomo.cc/api/v1/links/{id}

요청 예제:

curl --location --request DELETE 'https://ppomo.cc/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'