Xác thực
CrawlPipe có hai cơ chế xác thực riêng biệt. Trang này hướng dẫn cơ chế bạn sẽ sử dụng với tư cách là người tiêu dùng API.
Khóa API (/v1/*)
Mọi yêu cầu gửi tới API công khai đều xác thực bằng bearer API key:
Authorization: Bearer cp_live_a1b2c3d4e5f6…Khóa thuộc phạm vi tổ chức (org-scoped) — mỗi khóa thuộc về một tổ chức, không thuộc về người dùng cá nhân.
Định dạng khóa bắt đầu bằng cp_live_ theo sau là 32 ký tự ngẫu nhiên base62.
Hiển thị một lần
Khóa đầy đủ chỉ hiển thị duy nhất một lần khi tạo trong portal. Sau đó, CrawlPipe chỉ lưu trữ mã băm sha256 và chỉ hiển thị vài ký tự đầu (tiền tố) để nhận dạng. Nếu bạn mất khóa, hãy thu hồi và tạo khóa mới — không có cách nào khôi phục giá trị ban đầu.
Xác minh email là bắt buộc trước khi tạo khóa (điều này giúp ngăn chặn việc lạm dụng gói miễn phí bằng tài khoản rác).
Phạm vi (Scopes)
| Phạm vi | Quyền hạn |
|---|---|
read | Tất cả endpoint dữ liệu GET /v1/{domain}/* (tìm kiếm, văn bản, thay đổi, …) |
manage | Quản lý webhook và endpoint mức sử dụng qua API |
Khóa mới mặc định có quyền {read}. Yêu cầu quyền manage một cách rõ ràng khi tạo khóa nếu tích hợp của bạn cần tạo/danh sách/xóa webhook qua API thay vì qua giao diện portal.
Thu hồi
Việc thu hồi khóa trong portal có hiệu lực ngay lập tức trong cơ sở dữ liệu; bộ nhớ đệm in-process trên API sẽ đồng bộ tối đa trong 60 giây. Sau đó, các yêu cầu sử dụng khóa đã thu hồi sẽ nhận được lỗi 401 invalid_key.
Phiên làm việc Portal (/portal/*)
Portal chính (trang web này) xác thực bằng httpOnly session cookie kèm CSRF double-submit token — đây không phải là một phần của API công khai và bạn không cần dùng tới trong tích hợp của mình.
Giới hạn tần suất & gói dịch vụ
Mỗi phản hồi đều chứa các header X-RateLimit-Limit, X-RateLimit-Remaining, và X-RateLimit-Reset (unix timestamp), độc lập với mô hình đơn vị được đề cập trong Đo lường & idempotency. Giới hạn tùy thuộc từng gói — xem thêm tại Bảng giá.