Tài liệu API
Chào mừng bạn đến với hệ thống API của TikAff. API của chúng tôi cho phép bạn tích hợp việc tạo link Deep Link vào ứng dụng, bot Telegram hoặc quy trình làm việc tự động của bạn một cách nhanh chóng.
Xác thực
Mọi yêu cầu API phải bao gồm mã API Key của bạn để xác thực. Bạn có thể lấy hoặc làm mới mã này trong trang Hồ sơ cá nhân.
Chúng tôi hỗ trợ 2 phương thức gửi mã xác thực:
1. Gửi qua Header (Khuyên dùng)
X-API-KEY: your_api_key_here
2. Gửi qua tham số Body
api_key=your_api_key_here
Tạo Deep Link
Endpoint này cho phép bạn tạo một link Deep Link mới từ link sản phẩm TikTok.
Tham số truyền vào
| Tham số | Kiểu | Mô tả |
|---|---|---|
| web_link* | String | Link sản phẩm TikTok gốc cần chuyển đổi. |
| domain_id | Integer | ID của tên miền riêng (Nếu có). Mặc định hệ thống sẽ dùng tên miền có sẵn. |
| prefix_id | Integer | ID của tiền tố link (Ví dụ: /go/, /out/). Lấy từ endpoint get_available_options. |
| custom_alias | String | Bí danh tùy chỉnh cho link (Ví dụ: san-pham-hot). Chỉ áp dụng cho gói có quyền Alias. |
Ví dụ cURL
curl -X POST "https://app.tikaff.net/api.php" \
-H "X-API-KEY: YOUR_API_KEY" \
-d "web_link=https://vt.tiktok.com/ZS..."
Kết quả trả về (JSON)
{
"success": true,
"original_url": "https://vt.tiktok.com/ZS...",
"new_file_url": "https://tuoitre.top/reel/san-pham-hot",
"product_id": "7421356890...",
"deeplink": "snssdk1128://..."
}
Tạo hàng loạt (Bulk Mode)
Để tối ưu hiệu suất và tránh timeout, chúng tôi khuyến khích sử dụng chế độ tạo tuần tự thông qua Endpoint bulk_create_single trong một vòng lặp từ phía ứng dụng của bạn.
Tham số truyền vào
| Tham số | Kiểu | Mô tả |
|---|---|---|
| action* | String | Giá trị bắt buộc là bulk_create_single |
| web_link* | String | Link TikTok đích của một mục trong danh sách hàng loạt. |
| domain_id | Integer | ID tên miền sử dụng cho toàn bộ danh sách. |
| prefix_id | Integer | ID tiền tố sử dụng cho toàn bộ danh sách. |
bulk_create_notify để hệ thống gửi thông báo tổng kết qua Telegram cho bạn.
Cập nhật link gốc
Thay đổi link TikTok đích của một Deep Link mà không làm thay đổi URL rút gọn. Rất hữu ích khi link sản phẩm cũ bị thay thế.
Tham số truyền vào
| Tham số | Kiểu | Mô tả |
|---|---|---|
| action* | String | Giá trị bắt buộc là update_link |
| link_id* | Integer | ID của link cần cập nhật. |
| new_url* | String | Link TikTok mới cần trỏ tới. |
Xóa link
Hệ thống sẽ xóa và thu hồi link.
Tham số truyền vào
| Tham số | Kiểu | Mô tả |
|---|---|---|
| action* | String | Giá trị bắt buộc là delete_link |
| link_id* | Integer | ID của link cần xóa. |
Ghim/Bỏ ghim link
Đánh dấu link quan trọng để hiển thị ưu tiên. Mỗi tài khoản được ghim tối đa 5 link.
Tham số truyền vào
| Tham số | Kiểu | Mô tả |
|---|---|---|
| action* | String | Giá trị bắt buộc là toggle_pin_link |
| link_id* | Integer | ID của link cần ghim hoặc bỏ ghim. |
Tên miền và Prefix
Endpoint này trả về danh sách các Tên miền và Prefix mà bạn có thể sử dụng khi tạo link.
Tham số truyền vào
| Tham số | Kiểu | Mô tả |
|---|---|---|
| action* | String | Giá trị bắt buộc là get_available_options |
Phản hồi (JSON)
{
"success": true,
"domains": [
{ "id": 44, "domain": "tuoitre.top", "is_default": 1 },
{ "id": 4, "domain": "i.me-fb.com", "is_default": 0 }
],
"prefixes": [
{ "id": 1, "prefix": "reel", "is_default": 1 },
{ "id": 2, "prefix": "v", "is_default": 0 }
]
}
Lấy lịch sử link
Truy xuất danh sách các link bạn đã tạo gần đây.
Tham số truyền vào
| Tham số | Kiểu | Mô tả |
|---|---|---|
| action* | String | Giá trị bắt buộc là get_history |
| q | String | Từ khóa tìm kiếm theo URL gốc hoặc link rút gọn. |
| page | Integer | Số trang hiện tại (Mặc định: 1) |
| limit | Integer | Số bản ghi trên mỗi trang (Mặc định: 10) |
Ví dụ PHP
<?php
$ch = curl_init("https://app.tikaff.net/api.php");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-API-KEY: YOUR_KEY"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, ["action" => "get_history"]);
$response = curl_exec($ch);
$data = json_decode($response, true);
print_r($data["history"]);
Chi tiết lượt Click
Xem danh sách các lần click gần nhất của một link cụ thể.
Tham số truyền vào
| Tham số | Kiểu | Mô tả |
|---|---|---|
| action* | String | Giá trị bắt buộc là get_click_details |
| link_id* | Integer | ID của link cần xem (Lấy từ kết quả lịch sử). |
Ví dụ cURL
curl -X POST "https://app.tikaff.net/api.php" \
-d "action=get_click_details&link_id=123" \
-H "X-API-KEY: YOUR_KEY"
Lịch sử chỉnh sửa
Truy xuất danh sách các lần thay đổi URL gốc của một link cụ thể. Tính năng này giúp theo dõi biến động của link đích theo thời gian.
Tham số truyền vào
| Tham số | Kiểu | Mô tả |
|---|---|---|
| action* | String | Giá trị bắt buộc là get_edit_history |
| link_id* | Integer | ID của link cần xem lịch sử sửa đổi. |
Chuyển quyền sở hữu
Chuyển một link từ tài khoản của bạn sang tài khoản khác. Sau khi chuyển, bạn sẽ không còn quyền quản lý link này.
Tham số truyền vào
| Tham số | Kiểu | Mô tả |
|---|---|---|
| action* | String | Giá trị bắt buộc là transfer_link |
| link_id* | Integer | ID của link cần chuyển nhượng. |
| recipient* | String | Username hoặc Email của người nhận. |
WordPress Plugin
Chúng tôi cung cấp Plugin chính thức cho WordPress giúp bạn tích hợp TikAff Deep Link vào website tin tức hoặc affiliate một cách dễ dàng.
- Tự động chuyển đổi link TikTok trong bài viết.
- Shortcode linh hoạt [tikaff_form] và [tikaff_link].
- Tích hợp trực tiếp vào trình soạn thảo (Classic Editor & Gutenberg).
- ...
Code mẫu tích hợp
Dưới đây là các ví dụ cơ bản để bạn bắt đầu sử dụng API với ngôn ngữ yêu thích.
<?php
$api_url = "https://app.tikaff.net/api.php";
$api_key = "YOUR_API_KEY";
$data = [
'web_link' => 'https://vt.tiktok.com/ZS...',
'action' => 'create'
];
$ch = curl_init($api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-API-KEY: $api_key"]);
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response, true);
echo "Deep Link: " . $result['new_file_url'];
import requests
api_url = "https://app.tikaff.net/api.php"
headers = {"X-API-KEY": "YOUR_API_KEY"}
data = {
"web_link": "https://vt.tiktok.com/ZS...",
"action": "create"
}
response = requests.post(api_url, headers=headers, data=data)
print(f"Deep Link: {response.json().get('new_file_url')}")
const axios = require('axios');
const apiUrl = 'https://app.tikaff.net/api.php';
const apiKey = 'YOUR_API_KEY';
axios.post(apiUrl, {
web_link: 'https://vt.tiktok.com/ZS...',
action: 'create'
}, {
headers: { 'X-API-KEY': apiKey }
})
.then(res => console.log('Deep Link:', res.data.new_file_url))
.catch(err => console.error(err));