Danh mục liên kết

Lấy toàn bộ danh sách

Cổng kết nối đầu cuối (Endpoint)

GET https://go.hvsc.vn/api/links/

Mẫu ví dụ gửi yêu cầu

curl --request GET \
--url 'https://go.hvsc.vn/api/links/' \
--header 'Authorization: Bearer {api_key}' \

Các tham số truyền vào	Chi tiết	Mô tả
search	Tùy chọn phụ Chuỗi ký tự (String)	Từ khóa nội dung chuỗi tìm kiếm dữ liệu.
search_by	Tùy chọn phụ Chuỗi ký tự (String)	Chỉ định trường dữ liệu cụ thể nào bạn muốn áp dụng từ khóa tìm kiếm. Các giá trị được chấp nhận là: `url` , `location_url`.
is_enabled	Tùy chọn phụ Giá trị đúng/sai (Boolean)
domain_id	Tùy chọn phụ Số nguyên (Integer)
type	Tùy chọn phụ Chuỗi ký tự (String)	`biolink` , `link` , `file` , `vcard` , `event` , `static`
order_by	Tùy chọn phụ Chuỗi ký tự (String)	Chỉ định trường tiêu chí dữ liệu dùng làm căn cứ sắp xếp thứ tự danh sách kết quả trả về. Các giá trị được chấp nhận là: `link_id` , `datetime` , `last_datetime` , `clicks` , `url`.
order_type	Tùy chọn phụ Chuỗi ký tự (String)	Hình thức quy định sắp xếp danh sách kết quả hiển thị. Các giá trị được chấp nhận là: `ASC` cho kiểu sắp xếp tăng dần, và `DESC` cho kiểu sắp xếp giảm dần.
page	Tùy chọn phụ Số nguyên (Integer)	Số thứ tự số trang hiển thị kết quả dữ liệu mà bạn muốn lấy về. Giá trị mặc định ban đầu là `1`.
results_per_page	Tùy chọn phụ Số nguyên (Integer)	Quy định số lượng dòng kết quả dữ liệu trả về tối đa trên mỗi trang hiển thị. Các giá trị được hệ thống chấp nhận là: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Cấu hình mặc định ban đầu là `25`.

Mẫu kết quả phản hồi trả về

{
    "data": [
        {
            "id": 1,
            "project_id": null,
            "domain_id": 0,
            "type": "link",
            "url": "example",
            "location_url": "https://example.com/",
            "settings": {
                "password": null,
                "sensitive_content": false
            },
            "clicks": 10,
            "order": 0,
            "start_date": null,
            "end_date": null,
            "datetime": "2026-10-16 22:42:38",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://go.hvsc.vn/api/links?page=1",
        "last": "https://go.hvsc.vn/api/links?page=1",
        "next": null,
        "prev": null,
        "self": "https://go.hvsc.vn/api/links?page=1"
    }
}

Lấy chi tiết một mục

Cổng kết nối đầu cuối (Endpoint)

GET https://go.hvsc.vn/api/links/{link_id}

Mẫu ví dụ gửi yêu cầu

curl --request GET \
--url 'https://go.hvsc.vn/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

Mẫu kết quả phản hồi trả về

{
    "data": {
        "id": 1,
        "project_id": null,
        "domain_id": 0,
        "type": "link",
        "url": "example",
        "location_url": "https://example.com/",
        "settings": {
            "password": null,
            "sensitive_content": false
        },
        "clicks": 10,
        "order": 0,
        "start_date": null,
        "end_date": null,
        "datetime": "2026-10-16 22:42:38",
    }
}

Các tham số truyền vào	Chi tiết	Mô tả
type	Tùy chọn phụ Chuỗi ký tự (String)	`link`
location_url	Bắt buộc Chuỗi ký tự (String)	Đường dẫn liên kết URL gốc đích đến cuối cùng.Khả dụng khi cấu hình thỏa mãn điều kiện: is_bulk = 0
location_urls	Bắt buộc Chuỗi ký tự (String)	Đường dẫn liên kết URL gốc đích đến cuối cùng.Khả dụng khi cấu hình thỏa mãn điều kiện: is_bulk = 1
url	Tùy chọn phụ Chuỗi ký tự (String)	Chuỗi định danh alias URL ngắn được tạo ra cho liên kết. Hãy để trống trường này nếu muốn hệ thống tự động sinh ngẫu nhiên một chuỗi định danh.Khả dụng khi cấu hình thỏa mãn điều kiện: is_bulk = 0
is_bulk	Tùy chọn phụ Giá trị đúng/sai (Boolean)
domain_id	Tùy chọn phụ Số nguyên (Integer)	-
project_id	Tùy chọn phụ Số nguyên (Integer)	-
pixels_ids	Tùy chọn phụ Mảng dữ liệu (Array) Số nguyên (Integer)	-
email_reports	Tùy chọn phụ Mảng dữ liệu (Array)	Danh sách mã ID của các bộ xử lý thông báo
schedule	Tùy chọn phụ Giá trị đúng/sai (Boolean)	-
start_date	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: schedule = true
end_date	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: schedule = true
clicks_limit	Tùy chọn phụ Số nguyên (Integer)	-
expiration_url	Tùy chọn phụ Chuỗi ký tự (String)	-
sensitive_content	Tùy chọn phụ Giá trị đúng/sai (Boolean)	-
http_status_code	Tùy chọn phụ Số nguyên (Integer)	Các giá trị được chấp nhận: `301`, `302`, `307`, `308`
app_linking_is_enabled	Tùy chọn phụ Giá trị đúng/sai (Boolean)	-
cloaking_is_enabled	Tùy chọn phụ Giá trị đúng/sai (Boolean)	-
cloaking_title	Tùy chọn phụ Chuỗi ký tự (String)	-
cloaking_meta_description	Tùy chọn phụ Chuỗi ký tự (String)	-
cloaking_custom_js	Tùy chọn phụ Chuỗi ký tự (String)	-
cloaking_favicon	Tùy chọn phụ Tệp tin dữ liệu	-
cloaking_opengraph	Tùy chọn phụ Tệp tin dữ liệu	-
password	Tùy chọn phụ Chuỗi ký tự (String)	-
forward_query_parameters_is_enabled	Tùy chọn phụ Giá trị đúng/sai (Boolean)	-
utm_source	Tùy chọn phụ Chuỗi ký tự (String)	-
utm_medium	Tùy chọn phụ Chuỗi ký tự (String)	-
utm_campaign	Tùy chọn phụ Chuỗi ký tự (String)	-
targeting_type	Tùy chọn phụ Chuỗi ký tự (String)	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = continent_code
targeting_continent_code_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = continent_code
targeting_country_code_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = country_code
targeting_country_code_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = country_code
targeting_city_name_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = city_name
targeting_city_name_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = city_name
targeting_device_type_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = device_type
targeting_device_type_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = device_type
targeting_browser_language_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = browser_language
targeting_browser_language_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = browser_language
targeting_rotation_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = rotation
targeting_rotation_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = rotation
targeting_os_name_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = os_name
targeting_os_name_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = os_name
targeting_browser_name_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = browser_name
targeting_browser_name_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = browser_name

curl --request POST \
--url 'https://go.hvsc.vn/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://go.hvsc.vn/' \

Mẫu kết quả phản hồi trả về

{
    "data": {
        "id": 1
    }
}

Cập nhật thay đổi

Cổng kết nối đầu cuối (Endpoint)

POST https://go.hvsc.vn/api/links/{link_id}

Các tham số truyền vào	Chi tiết	Mô tả
location_url	Tùy chọn phụ Chuỗi ký tự (String)	Đường dẫn liên kết URL gốc đích đến cuối cùng.
url	Tùy chọn phụ Chuỗi ký tự (String)	Chuỗi định danh alias URL ngắn được tạo ra cho liên kết. Hãy để trống trường này nếu muốn hệ thống tự động sinh ngẫu nhiên một chuỗi định danh.
domain_id	Tùy chọn phụ Số nguyên (Integer)	-
project_id	Tùy chọn phụ Số nguyên (Integer)	-
pixels_ids	Tùy chọn phụ Mảng dữ liệu (Array) Số nguyên (Integer)	-
email_reports	Tùy chọn phụ Mảng dữ liệu (Array)	Danh sách mã ID của các bộ xử lý thông báo
schedule	Tùy chọn phụ Giá trị đúng/sai (Boolean)	-
start_date	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: schedule = true
end_date	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: schedule = true
clicks_limit	Tùy chọn phụ Số nguyên (Integer)	-
expiration_url	Tùy chọn phụ Chuỗi ký tự (String)	-
sensitive_content	Tùy chọn phụ Giá trị đúng/sai (Boolean)	-
http_status_code	Tùy chọn phụ Số nguyên (Integer)	Các giá trị được chấp nhận: `301`, `302`, `307`, `308`
app_linking_is_enabled	Tùy chọn phụ Giá trị đúng/sai (Boolean)	-
cloaking_is_enabled	Tùy chọn phụ Giá trị đúng/sai (Boolean)	-
cloaking_title	Tùy chọn phụ Chuỗi ký tự (String)	-
cloaking_meta_description	Tùy chọn phụ Chuỗi ký tự (String)	-
cloaking_custom_js	Tùy chọn phụ Chuỗi ký tự (String)	-
cloaking_favicon	Tùy chọn phụ Tệp tin dữ liệu	-
cloaking_opengraph	Tùy chọn phụ Tệp tin dữ liệu	-
password	Tùy chọn phụ Chuỗi ký tự (String)	-
forward_query_parameters_is_enabled	Tùy chọn phụ Giá trị đúng/sai (Boolean)	-
utm_source	Tùy chọn phụ Chuỗi ký tự (String)	-
utm_medium	Tùy chọn phụ Chuỗi ký tự (String)	-
utm_campaign	Tùy chọn phụ Chuỗi ký tự (String)	-
targeting_type	Tùy chọn phụ Chuỗi ký tự (String)	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = continent_code
targeting_continent_code_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = continent_code
targeting_country_code_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = country_code
targeting_country_code_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = country_code
targeting_city_name_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = city_name
targeting_city_name_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = city_name
targeting_device_type_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = device_type
targeting_device_type_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = device_type
targeting_browser_language_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = browser_language
targeting_browser_language_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = browser_language
targeting_rotation_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = rotation
targeting_rotation_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = rotation
targeting_os_name_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = os_name
targeting_os_name_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = os_name
targeting_browser_name_key[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = browser_name
targeting_browser_name_value[index]	Tùy chọn phụ Chuỗi ký tự (String)	Khả dụng khi cấu hình thỏa mãn điều kiện: targeting_type = browser_name

Mẫu ví dụ gửi yêu cầu

curl --request POST \
--url 'https://go.hvsc.vn/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \

Mẫu kết quả phản hồi trả về

{
    "data": {
        "id": 1
    }
}

Xóa bỏ dữ liệu

Cổng kết nối đầu cuối (Endpoint)

DELETE https://go.hvsc.vn/api/links/{link_id}

Mẫu ví dụ gửi yêu cầu

curl --request DELETE \
--url 'https://go.hvsc.vn/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

Danh mục liên kết

Lấy toàn bộ danh sách

Lấy chi tiết một mục

Tạo mới dữ liệu

Cập nhật thay đổi

Xóa bỏ dữ liệu