連結

驗證
API 金鑰應以 Bearer 令牌形式在請求的授權標頭中傳送。 取得您的 API 金鑰.
列出

API 端點

GET 
https://ysd.lol/api/v1/links

請求範例 

curl --location --request GET 'https://ysd.lol/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parameters

姓名
類型
說明
search
可選 string
搜尋查詢.
search_by
可選 string
搜尋方式. 可能的值為：標題 的 title, 別名 的 alias, 網址 的 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, 網址 的 url。 預設為：id。
sort
可選 string
排序. 可能的值為：遞減 的 desc, 遞增 的 asc。 預設為：desc。
per_page
可選 integer
每頁顯示結果. 可能的值為：10, 25, 50, 100。 預設為：10。
顯示

API 端點

GET 
https://ysd.lol/api/v1/links/{id}

請求範例 

curl --location --request GET 'https://ysd.lol/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
建立

API 端點

POST 
https://ysd.lol/api/v1/links

請求範例 

curl --location --request POST 'https://ysd.lol/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'

Parameters

姓名
類型
說明
url
必要 string
目的地網址.
domain_id
必要 integer
網域 ID.
alias
可選 string
別名.
space_id
可選 integer
空間 ID.
pixel_ids[]
可選 array
追蹤像素 ID.
redirect_password
可選 string
重導密碼.
sensitive_content
可選 integer
敏感內容. 可能的值為：否 的 0, 是 的 1。 預設為：0。
privacy
可選 integer
統計隱私. 可能的值為：公開 的 0, 私密 的 1, 密碼 的 2。 預設為：0。
password
可選 string
統計密碼. 僅在 privacy 欄位設為 2 時有效。
active_period_start_at
可選 string
Y-m-dTH:i:s 格式的有效期間開始日期。
active_period_end_at
可選 string
Y-m-dTH:i:s 格式的有效期間結束日期。
clicks_limit
可選 integer
點擊限制.
expiration_url
可選 string
到期網址.
targets_type
可選 string
指向. 可能的值為：Continents 的 continents, Countries 的 countries, Operating systems 的 operating_systems, Browsers 的 browsers, Languages 的 languages, Devices 的 devices, Rotations 的 rotations。
targets[index][key]
可選 string

對於 targets_type=country，值必須為 ISO 3166-1 alpha-2 格式。

對於 targets_type=operating_systems，可能的值為：iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS。

對於 targets_type=browsers，可能的值為：Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho。

對於 targets_type=devices，可能的值為：Desktop, Mobile, Tablet, Watch, Television。

對於 targets_type=languages，值必須為 ISO 639-1 alpha-2 格式。

對於 targets_type=continents，可能的值為：Africa 的 AF, Antarctica 的 AN, Asia 的 AS, Europe 的 EU, North America 的 NA, Oceania 的 OC, South America 的 SA。

targets[index][value]
可選 string
目的地網址.
更新

API 端點

PUT PATCH 
https://ysd.lol/api/v1/links/{id}

請求範例 

curl --location --request PUT 'https://ysd.lol/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Parameters

姓名
類型
說明
url
可選 string
目的地網址.
alias
可選 string
別名.
space_id
可選 integer
空間 ID.
pixel_ids[]
可選 array
追蹤像素 ID.
redirect_password
可選 string
重導密碼.
sensitive_content
可選 integer
敏感內容. 可能的值為：否 的 0, 是 的 1。
privacy
可選 integer
統計隱私. 可能的值為：公開 的 0, 私密 的 1, 密碼 的 2。
password
可選 string
統計密碼. 僅在 privacy 欄位設為 2 時有效。
active_period_start_at
可選 string
Y-m-dTH:i:s 格式的有效期間開始日期。
active_period_end_at
可選 string
Y-m-dTH:i:s 格式的有效期間結束日期。
clicks_limit
可選 integer
點擊限制.
expiration_url
可選 string
到期網址.
targets_type
可選 string
指向. 可能的值為：Continents 的 continents, Countries 的 countries, Operating systems 的 operating_systems, Browsers 的 browsers, Languages 的 languages, Devices 的 devices, Rotations 的 rotations。
targets[index][key]
可選 string

對於 targets_type=country，值必須為 ISO 3166-1 alpha-2 格式。

對於 targets_type=operating_systems，可能的值為：iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS。

對於 targets_type=browsers，可能的值為：Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho。

對於 targets_type=devices，可能的值為：Desktop, Mobile, Tablet, Watch, Television。

對於 targets_type=languages，值必須為 ISO 639-1 alpha-2 格式。

對於 targets_type=continents，可能的值為：Africa 的 AF, Antarctica 的 AN, Asia 的 AS, Europe 的 EU, North America 的 NA, Oceania 的 OC, South America 的 SA。

targets[index][value]
可選 string
目的地網址.
刪除

API 端點

DELETE 
https://ysd.lol/api/v1/links/{id}

請求範例 

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