Tham chiếu · SDK

SDK trình duyệt

Thẻ script, mọi thuộc tính data-*, sự kiện và API trên window.

Một thẻ <script>. Không có gói npm, thẻ này là toàn bộ phần tích hợp phía trình duyệt.

<script src="https://hideguard.io/sdk/v1.js"
        data-site-key="pk_live_..."
        data-block="true"></script>

Thuộc tính#

Thuộc tính	Mặc định	Ý nghĩa
`data-site-key`	bắt buộc	Khoá công khai của site
`data-endpoint`	origin của chính script	Nơi gửi dữ liệu. Chỉ cần khi script phục vụ từ CDN
`data-auto`	`true`	Thu thập ngay khi tải. `false` để tự gọi
`data-block`	`false`	Hiện màn chặn khi phán quyết là `block`
`data-cookie`	`true`	Đặt cookie `fpc_vid` trên tên miền của bạn
`data-heartbeat`	`true`	Đập nhịp để dashboard đếm số trang đang mở
`data-behavior`	`true`	Thu thập hành vi. Không thêm request nào
`data-requests`	`false`	Tự chọn. Ghi lại các request trang bạn tự gọi
`data-active-probes`	`false`	Bật các phép đo chủ động, tốn kém hơn
`data-syn-check`	`true`	Hỏi gói SYN của chính kết nối người truy cập
`data-ip-check`	tắt	URL của một host thứ hai trả lời "bạn thấy tôi ở địa chỉ nào"
`data-ip-check-key`	khoá kèm sẵn	Khoá cho host đó, khi bạn tự chạy bản sao

Vì sao `data-block` tắt mặc định#

Một script có thể làm đen trang của khách ngay khi vừa cài là một script không ai nên cài.

Vì sao `data-requests` phải tự chọn#

Nó thay thế fetch và XMLHttpRequest.prototype.send của trang bạn. Thêm một listener là việc script làm với chính nó; bọc transport là việc nó làm với ứng dụng của bạn.

Nó không giữ lại gì và không đổi giá trị trả về. Nó gọi transport gốc với đúng tham số của bạn và trả về đúng thứ transport trả về.

API trên window#

// Thu thập thủ công khi data-auto="false"
const result = await window.FingerprintCollector.collect();

Sự kiện#

window.addEventListener("fpc:verdict", (event) => {
  const { verdict, score, visitorId, requestId } = event.detail;
});

Phán quyết này là thông tin, không phải cổng chặn. Nó đến sau khi trang đã được phục vụ, và một client không chạy JavaScript không bao giờ gặp nó. Nửa chặn được là POST /api/v1/verdict.