API quản lý LR Link
Quản lý chiến dịch LR Link từ máy chủ của bạn bằng API key lrs_ với scope link:read và link:write: chiến dịch, lượt, click, thống kê, chặn mạng và kho mã.
EndpointGET
https://api.lrsvn.com/v1/link/campaignsDashboard /app/link dùng cùng API này. Từ máy chủ, gửi Authorization: Bearer lrs_… với scope link:read (đọc) và link:write (ghi); tạo API key ở /app/settings › API. Lệnh ghi (POST, PATCH, DELETE) gửi kèm Idempotency-Key 8–128 ký tự. Bật dịch vụ, xoá chiến dịch và xoay khoá ký cần phiên đăng nhập Owner/Admin.
Yêu cầu
| Lệnh | Scope | Việc |
|---|---|---|
GET /link/account | read | Trạng thái dịch vụ và hạn mức. |
GET /link/campaigns | read | Danh sách chiến dịch (?q=&status=). |
POST /link/campaigns | write | Tạo chiến dịch: name, description, status, devices, run_ttl_seconds, min_click_gap_seconds, user_daily_completions, links [{label, url}] (bể ban đầu), links_per_run, actions. |
GET /link/campaigns/{id} | read | Chi tiết, kèm khoá ký công khai và 100 link đầu của bể. |
PATCH /link/campaigns/{id} | write | Sửa; gửi kèm expected_updated_at (409 link_campaign_changed nếu người khác vừa sửa). links thay cả bể. |
GET /link/campaigns/{id}/pool | read | Bể link (`?q=&status=enabled\ |
POST /link/campaigns/{id}/pool, PATCH / DELETE …/pool/{linkId} | write | Thêm, sửa, bật/tắt, xoá một link. Chiến dịch đang chạy không giảm được dưới links_per_run link bật (409 link_pool_too_small). |
POST /link/campaigns/{id}/pool/import | write | Nhập tối đa 1000 dòng `nhãn \ |
GET /link/campaigns/{id}/runs | read | Lượt (?status=&external_user=). |
POST /link/campaigns/{id}/runs | write | Máy chủ tạo lượt thay ứng dụng, cùng thân external_user; câu trả lời không ký (đã có API key). |
GET /link/campaigns/{id}/runs/{runId} | read | Chi tiết lượt, các lần mở và result (kèm khoá/mã). |
GET /link/campaigns/{id}/clicks | read | Các lần mở, kể cả bị từ chối (lý do). |
GET /link/campaigns/{id}/stats | read | Lượt, hoàn thành, lượt mở theo ngày (?range=7d hoặc 30d). |
GET / POST /link/campaigns/{id}/blocks, DELETE …/blocks/{blockId} | read / write | Chặn một địa chỉ hoặc dải mạng (IPv4 từ /16, IPv6 từ /32; một địa chỉ IPv6 là dải /64 của nó), kèm lý do. |
GET / POST / DELETE /link/campaigns/{id}/codes | read / write | Kho mã. |
Ví dụ: tạo lượt từ máy chủ
curl -s https://api.lrsvn.com/v1/link/campaigns/lcmp_8kq2m7x4c1/runs \
-H 'Authorization: Bearer lrs_xxxxxxxx' \
-H 'Idempotency-Key: 6f1d2c3a-run-player-42' \
-H 'Content-Type: application/json' \
-d '{"external_user":"player-42"}'Phản hồi
Câu trả lời giống client API (run_id, status, links, expires_at) nhưng không có chữ ký: máy chủ đã xác thực bằng API key. Gửi link bọc cho người dùng (chat, email…), rồi nhận kết quả qua webhook hoặc đọc chi tiết lượt.
Mã lỗi
| HTTP | Mã | Khi nào |
|---|---|---|
| 403 | link_not_enabled | Tổ chức chưa bật LR Link. |
| 423 | link_suspended | LR Link của tổ chức bị LRS tạm khoá. |
| 423 | link_campaign_suspended | Chiến dịch bị LRS tạm khoá; không bật lại được. |
| 404 | link_campaign_not_found | Chiến dịch không có. |
| 409 | link_campaign_changed | expected_updated_at đã cũ. |
| 422 | validation_error | Sai trường; xem fields. |
| 503 | link_domain_unavailable | Chưa có tên miền link sẵn sàng; thử lại sau. |