Liên kết

Lưu ý
Trình độ chuyên gia
Khóa API phải được gửi dưới dạng Bearer Token trong Authorization header của yêu cầu. Lấy khóa API.
Danh sách

Điểm cuối API:

GET
https://rutgon.com.vn/api/v1/links

Yêu cầu ví dụ:

curl --location --request GET 'https://rutgon.com.vn/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Tham số
Nhập
Mô tả
search
tùy chọn string
Truy vấn tìm kiếm.
by
tùy chọn string
Tìm kiếm bởi. 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 tình trạng. Giá trị có thể là: 0 cho Tất cả, 1 cho Kích hoạt, 2 cho Đã hết hạn, 3 cho Vô hiệu hóa. Mặc định là: 0.
space
tùy chọn integer
Lọc theo nhận diện không gian.
domain
tùy chọn integer
Lọc theo nhận diện tên miền.
sort
tùy chọn string
Sắp xếp. Giá trị có thể là: desc cho Giảm dần, asc cho Tăng dần, max cho Hoạt động tốt nhất, min cho Hoạt động yếu nhất. Mặc định là: desc.
per_page
tùy chọn int
Kết quả trên mỗi trang. Giá trị có thể là: 10 đến 100. Mặc định là: 10.
Hiển thị

Điểm cuối API:

GET
https://rutgon.com.vn/api/v1/links/{id}

Yêu cầu ví dụ:

curl --location --request GET 'https://rutgon.com.vn/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Cửa hàng

Điểm cuối API:

POST
https://rutgon.com.vn/api/v1/links

Yêu cầu ví dụ:

curl --location --request POST 'https://rutgon.com.vn/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Tham số
Nhập
Mô tả
url
yêu cầu string
Liên kết được rút gọ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
tùy chọn integer
Không gian nhận diện liên kết sẽ được lưu bên dưới.
domain
tùy chọn integer
Tên miền nhận diện liên kết sẽ được lưu ở dưới.
pixels
tùy chọn array
The pixel IDs to be integrated in the link.
disabled
tùy chọn integer
Bất kể liên kết có bị vô hiệu hay không. Giá trị có thể là: 0 cho Kích hoạt, 1 cho Vô hiệu hóa. Mặc định là: 0.
privacy
tùy chọn integer
Bất kể tình trạng liên kết công khai hay không Giá trị có thể là: 0 cho Riêng tư, 1 cho Công khai, 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 với privacy được đặt thành 2.
expiration_url
tùy chọn string
Liên kết nơi người dùng được chuyển hướng sau 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 trong định dạng YYYY-MM-DD.
expiration_time
tùy chọn string
Thời gian hết hạn liên kết trong định dạng HH:MM.
expiration_clicks
tùy chọn integer
Số lượt nhấp còn lại cho đến khi liên kết hết hạn.
target_type
tùy chọn integer
Các loại nhắm mục tiêu. Giá trị có thể là: 0 cho Không, 1 cho Địa lý, 2 cho Nền tảng, 4 cho Quay vòng.
country[index][key]
tùy chọn string
Mã quốc gia được nhắm mục tiêu. Mã cần phải nằm trong tiêu chuẩn ISO 3166-1 alpha-2.
country[index][value]
tùy chọn string
Liên kết quốc gia nơi người dùng sẽ được chuyển hướng đến.
platform[index][key]
tùy chọn string
Tên nền tảng được nhắm mục tiêu. 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 quốc gia nơi người dùng sẽ được chuyển hướng đến.
language[index][key]
tùy chọn string
Mã ngôn ngữ được nhắm mục tiêu. Mã cần phải nằm trong tiêu chuẩn ISO 639-1 alpha-2.
language[index][value]
tùy chọn string
Liên kết quốc gia nơi người dùng sẽ được chuyển hướng đến.
rotation[index][value]
tùy chọn string
Liên kết quốc gia nơi người dùng sẽ được chuyển hướng đến.
Cập nhật

Điểm cuối API:

PUT PATCH
https://rutgon.com.vn/api/v1/links/{id}

Yêu cầu ví dụ:

curl --location --request PUT 'https://rutgon.com.vn/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Tham số
Nhập
Mô tả
url
tùy chọn string
Liên kết được rút gọ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
tùy chọn integer
Không gian nhận diện liên kết sẽ được lưu bên dưới.
domain
tùy chọn integer
Tên miền nhận diện liên kết sẽ được lưu ở dưới.
pixels
tùy chọn array
The pixel IDs to be integrated in the link.
disabled
tùy chọn integer
Bất kể liên kết có bị vô hiệu hay không. Giá trị có thể là: 0 cho Kích hoạt, 1 cho Vô hiệu hóa.
privacy
tùy chọn integer
Bất kể tình trạng liên kết công khai hay không Giá trị có thể là: 0 cho Riêng tư, 1 cho Công khai, 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 với privacy được đặt thành 2.
expiration_url
tùy chọn string
Liên kết nơi người dùng được chuyển hướng sau 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 trong định dạng YYYY-MM-DD.
expiration_time
tùy chọn string
Thời gian hết hạn liên kết trong định dạng HH:MM.
expiration_clicks
tùy chọn integer
Số lượt nhấp còn lại cho đến khi liên kết hết hạn.
target_type
tùy chọn integer
Các loại nhắm mục tiêu. Giá trị có thể là: 0 cho Không, 1 cho Địa lý, 2 cho Nền tảng, 4 cho Quay vòng.
country[index][key]
tùy chọn string
Mã quốc gia được nhắm mục tiêu. Mã cần phải nằm trong tiêu chuẩn ISO 3166-1 alpha-2.
country[index][value]
tùy chọn string
Liên kết quốc gia nơi người dùng sẽ được chuyển hướng đến.
platform[index][key]
tùy chọn string
Tên nền tảng được nhắm mục tiêu. 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 quốc gia nơi người dùng sẽ được chuyển hướng đến.
language[index][key]
tùy chọn string
Mã ngôn ngữ được nhắm mục tiêu. Mã cần phải nằm trong tiêu chuẩn ISO 639-1 alpha-2.
language[index][value]
tùy chọn string
Liên kết quốc gia nơi người dùng sẽ được chuyển hướng đến.
rotation[index][value]
tùy chọn string
Liên kết quốc gia nơi người dùng sẽ được chuyển hướng đến.
Xóa

Điểm cuối API:

DELETE
https://rutgon.com.vn/api/v1/links/{id}

Yêu cầu ví dụ:

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