Liên kết

Ghi chú
Cấp độ chuyên gia
Khóa API nên được gửi dưới dạng mã thông báo Bearer trong tiêu đề Ủy quyền của yêu cầu. Lấy khóa API của bạn.
Danh sách

Điểm cuối API:

GET
https://www.url.spa/api/v1/links

Ví dụ yêu cầu:

curl --location --request GET 'https://www.url.spa/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Tham số
Loại
Mô tả
search
tùy chọn string
Truy vấn tìm kiếm.
search_by
tùy chọn string
Tìm kiếm theo. Các giá trị có thể là: title cho Tiêu đề, alias cho Bí danh, url cho URL. Mặc định là: title.
status
tùy chọn integer
Lọc theo trạng thái. Các giá trị có thể là: 0 cho Tất cả, 1 cho Hoạt động, 2 cho Hết hạn, 3 cho Vô hiệu hóa. Mặc định là: 0.
space_id
tùy chọn integer
Lọc theo ID không gian.
domain_id
tùy chọn integer
Lọc theo ID tên miền.
pixel_id
tùy chọn integer
Lọc theo ID pixel.
sort_by
tùy chọn string
Sắp xếp theo. Các giá trị có thể là: id cho Ngày tạo, clicks cho Lượt nhấp, title cho Tiêu đề, alias cho Bí danh, url cho URL. Mặc định là: id.
sort
tùy chọn string
Sắp xếp. Các giá trị có thể là: desc cho Giảm dần, asc cho Tăng dần. Mặc định là: desc.
per_page
tùy chọn integer
Kết quả mỗi trang. Các giá trị có thể là: 10, 25, 50, 100. Mặc định là: 100.
Hiển thị

Điểm cuối API:

GET
https://www.url.spa/api/v1/links/{id}

Ví dụ yêu cầu:

curl --location --request GET 'https://www.url.spa/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Lưu trữ

Điểm cuối API:

POST
https://www.url.spa/api/v1/links

Ví dụ yêu cầu:

curl --location --request POST 'https://www.url.spa/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'
Tham số
Loại
Mô tả
url
bắt buộc string
Liên kết cần rút ngắn.
domain_id
bắt buộc integer
ID tên miền nơi liên kết sẽ được lưu.
alias
tùy chọn string
Bí danh liên kết.
password
tùy chọn string
Mật khẩu liên kết.
space_id
tùy chọn integer
ID không gian nơi liên kết sẽ được lưu.
pixel_ids
tùy chọn array
The pixel IDs to be integrated in the link.
disabled
tùy chọn integer
Liên kết có bị vô hiệu hóa hay không. Các giá trị có thể là: 0 cho Hoạt động, 1 cho Vô hiệu hóa. Mặc định là: 0.
privacy
tùy chọn integer
Thống kê liên kết có công khai hay không. Các giá trị có thể là: 0 cho Công khai, 1 cho Riêng tư, 2 cho Mật khẩu. Mặc định là: 0.
privacy_password
tùy chọn string
Mật khẩu cho trang thống kê. Chỉ hoạt động khi privacy được đặt thành 2.
expiration_url
tùy chọn string
Liên kết mà người dùng sẽ được chuyển hướng đến khi liên kết hết hạn.
expiration_date
tùy chọn string
Ngày hết hạn liên kết ở định dạng YYYY-MM-DD.
expiration_time
tùy chọn string
Thời gian hết hạn liên kết ở định dạng HH:MM.
expiration_clicks
tùy chọn integer
Số lượt nhấp sau đó liên kết nên hết hạn.
target_type
tùy chọn integer
Loại nhắm mục tiêu. Các giá trị có thể là: 0 cho Không có, 1 cho Địa lý, 2 cho Nền tảng, 4 cho Xoay vòng.
country[index][key]
tùy chọn string
Mã của quốc gia được nhắm mục tiêu. Mã phải tuân theo chuẩn ISO 3166-1 alpha-2.
country[index][value]
tùy chọn string
Liên kết mà người dùng sẽ được chuyển hướng đến.
platform[index][key]
tùy chọn string
Tên của nền tảng được nhắm mục tiêu. Các giá trị có thể là: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
tùy chọn string
Liên kết mà người dùng sẽ được chuyển hướng đến.
language[index][key]
tùy chọn string
Mã của ngôn ngữ được nhắm mục tiêu. Mã phải tuân theo chuẩn ISO 639-1 alpha-2.
language[index][value]
tùy chọn string
Liên kết mà người dùng sẽ được chuyển hướng đến.
rotation[index][value]
tùy chọn string
Liên kết mà người dùng sẽ được chuyển hướng đến.
Cập nhật

Điểm cuối API:

PUT PATCH
https://www.url.spa/api/v1/links/{id}

Ví dụ yêu cầu:

curl --location --request PUT 'https://www.url.spa/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Tham số
Loại
Mô tả
url
tùy chọn string
Liên kết cần rút ngắn.
alias
tùy chọn string
Bí danh liên kết.
password
tùy chọn string
Mật khẩu liên kết.
space_id
tùy chọn integer
ID không gian nơi liên kết sẽ được lưu.
pixel_ids
tùy chọn array
The pixel IDs to be integrated in the link.
disabled
tùy chọn integer
Liên kết có bị vô hiệu hóa hay không. Các giá trị có thể là: 0 cho Hoạt động, 1 cho Vô hiệu hóa.
privacy
tùy chọn integer
Thống kê liên kết có công khai hay không. Các giá trị có thể là: 0 cho Công khai, 1 cho Riêng tư, 2 cho Mật khẩu.
privacy_password
tùy chọn string
Mật khẩu cho trang thống kê. Chỉ hoạt động khi privacy được đặt thành 2.
expiration_url
tùy chọn string
Liên kết mà người dùng sẽ được chuyển hướng đến khi liên kết hết hạn.
expiration_date
tùy chọn string
Ngày hết hạn liên kết ở định dạng YYYY-MM-DD.
expiration_time
tùy chọn string
Thời gian hết hạn liên kết ở định dạng HH:MM.
expiration_clicks
tùy chọn integer
Số lượt nhấp sau đó liên kết nên hết hạn.
target_type
tùy chọn integer
Loại nhắm mục tiêu. Các giá trị có thể là: 0 cho Không có, 1 cho Địa lý, 2 cho Nền tảng, 4 cho Xoay vòng.
country[index][key]
tùy chọn string
Mã của quốc gia được nhắm mục tiêu. Mã phải tuân theo chuẩn ISO 3166-1 alpha-2.
country[index][value]
tùy chọn string
Liên kết mà người dùng sẽ được chuyển hướng đến.
platform[index][key]
tùy chọn string
Tên của nền tảng được nhắm mục tiêu. Các giá trị có thể là: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
tùy chọn string
Liên kết mà người dùng sẽ được chuyển hướng đến.
language[index][key]
tùy chọn string
Mã của ngôn ngữ được nhắm mục tiêu. Mã phải tuân theo chuẩn ISO 639-1 alpha-2.
language[index][value]
tùy chọn string
Liên kết mà người dùng sẽ được chuyển hướng đến.
rotation[index][value]
tùy chọn string
Liên kết mà người dùng sẽ được chuyển hướng đến.
Xóa

Điểm cuối API:

DELETE
https://www.url.spa/api/v1/links/{id}

Ví dụ yêu cầu:

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