API PlagiarismSearch: Câu hỏi và câu trả lời về tích hợp

Hướng dẫn thực hành về truy cập API, kiểm tra đạo văn bất đồng bộ, hàm gọi lại, báo cáo, bộ nhớ (Storage) riêng tư, bộ lọc và các vấn đề tích hợp thường gặp.

Ảnh chụp màn hình hiển thị quy trình làm việc API trước đó. Vui lòng kiểm tra tài liệu v3 được liên kết và cài đặt tài khoản của bạn trước khi triển khai tích hợp vào môi trường sản xuất.

API của PlagiarismSearch có thể làm được những gì?

API RESTful của PlagiarismSearch cho phép các nhà phát triển gửi văn bản hoặc các tệp được hỗ trợ để phân tích độ tương đồng, truy xuất kết quả và thông tin nguồn, đồng thời kết nối việc kiểm tra đạo văn với quy trình làm việc của tổ chức. Bộ nhớ riêng Storage có thể hỗ trợ so sánh với các tài liệu mà khách hàng chọn để lập chỉ mục.

Các tính năng và quyền hạn của API phụ thuộc vào tài khoản và các dịch vụ được kích hoạt. Không nên cho rằng các hoạt động đại lý bán lại, quyền truy cập ghi vào bộ nhớ (Storage) hoặc phát hiện AI đều được bao gồm trong mọi tài khoản. Tín hiệu viết bằng AI là hoàn toàn riêng biệt với việc phát hiện đạo văn hoặc sự tương đồng.

Tôi có thể lấy quyền truy cập API và thông tin đăng nhập bằng cách nào?

Hãy bắt đầu với Tổng quan về API chống đạo văn dành cho công chúng và Tài liệu API. Nếu cần quyền truy cập dùng thử hoặc thông tin về giá cả, hãy liên hệ services@plagiarismsearch.com để xác nhận các điều khoản hiện hành. Các tài liệu cũ hơn mô tả bản dùng thử 30 ngày với 100 lượt gửi, nhưng các quyền lợi chính xác đó chưa được xác minh đối với các đăng ký hiện tại.

Đối với tài khoản hiện có, hãy sử dụng trang API Credentials trong ứng dụng đã được xác nhận để xem tên người dùng và khóa API. Giữ thông tin xác thực trên máy chủ. Không bao giờ dán khóa đang hoạt động vào phiếu hỗ trợ, mã nguồn công khai hoặc ứng dụng chỉ chạy trong trình duyệt.

Quy trình báo cáo bất đồng bộ hoạt động như thế nào?

  1. Gửi văn bản, tệp tin hoặc URL công khai được cho phép thông qua reports/create.
  2. Ghi lại mã số báo cáo trả về và kiểm tra xem yêu cầu đã được chấp nhận hay chưa. Số dư và quyền truy cập tài khoản có thể ảnh hưởng đến quá trình xử lý.
  3. Máy chủ xử lý nội dung được gửi một cách bất đồng bộ. Thời gian xử lý có thể thay đổi tùy thuộc vào kích thước tài liệu, tài nguyên sẵn có và các tùy chọn phân tích đã chọn; không nên kỳ vọng vào thời gian hoàn thành cố định.
  4. Nhận thông báo hoàn thành tại callback_url đã cấu hình, hoặc sử dụng quy trình làm việc báo cáo trạng thái được ghi lại khi thích hợp.
  5. Truy xuất thông tin chi tiết và các liên kết báo cáo có sẵn bằng cách sử dụng reports/{id}.

Xem tài liệu tham chiếu về yêu cầu callback. Endpoint của bạn phải có thể truy cập qua HTTPS, xác thực các yêu cầu đến theo hợp đồng tích hợp hiện hành và xử lý an toàn các lần thử lại hoặc thông báo trùng lặp.

Yêu cầu tạo báo cáo trông như thế nào?

Phương thức tạo được ghi nhận là POST, không phải PUT. Ví dụ bên dưới minh họa cấu trúc của một yêu cầu; hãy sử dụng tên người dùng và khóa API phía máy chủ của bạn và xác nhận các tham số được hỗ trợ chính xác trong tài liệu.

curl --request POST \
  'https://plagiarismsearch.com/api/v3/reports/create' \
  --user 'YOUR_API_USER:YOUR_API_KEY' \
  --form 'text=Example document text for a similarity check.' \
  --form 'search_web=1' \
  --form 'search_storage=0' \
  --form 'callback_url=https://your-domain.example/api/plagiarism-callback'

Sử dụng trường biểu mẫu file khi gửi tệp. Tài liệu API cũng mô tả url, title, remote_id và các bộ lọc tùy chọn. Tránh đưa thông tin xác thực vào chuỗi truy vấn hoặc ảnh chụp màn hình.

Tôi có thể gửi tệp và xem báo cáo bằng cách nào?

Việc gửi tệp thông thường sử dụng trường file đã được ghi lại; báo cáo hoàn chỉnh có thể được truy xuất thông qua GET /api/v3/reports/{id}. Hai ảnh chụp màn hình này được giữ lại từ hướng dẫn tích hợp cũ hơn và chỉ mang tính minh họa chứ không thay thế cho tài liệu tham khảo API hiện tại.

Ví dụ cURL trước đó về việc gửi tài liệu thông qua API PlagiarismSearch.
Ví dụ về việc gửi yêu cầu API cURL trước đó; hãy kiểm tra thông tin xác thực và tên trường hiện tại trước khi sử dụng lại.
Ví dụ cURL trước đó để truy xuất báo cáo API PlagiarismSearch
Ví dụ về việc truy xuất báo cáo trước đó. Cần có ID báo cáo và yêu cầu đã được xác thực.

Tôi có thể lấy các nguồn và chi tiết báo cáo bằng cách nào?

Điểm cuối xem báo cáo v3 hỗ trợ show_relations. Các giá trị được ghi lại giúp kiểm soát lượng thông tin được trả về:

  • 0 — Thông tin báo cáo cơ bản (mặc định).
  • 1 — Cấu trúc báo cáo dạng cây với các đoạn văn, câu, nguồn tham khảo và văn bản được tô sáng.
  • -1 — các mối quan hệ báo cáo thô.
  • -2 — danh sách các nguồn phù hợp.
  • -3 — Nội dung báo cáo HTML, nếu được hỗ trợ.

Ví dụ: GET https://plagiarismsearch.com/api/v3/reports/REPORT_ID?show_relations=-2. Hãy kiểm tra lược đồ phản hồi trong tham chiếu điểm cuối hiện tại thay vì xây dựng URL từ các khóa báo cáo được mã hóa cứng cũ.

Điểm tương đồng và tỷ lệ phần trăm nguồn là bằng chứng để xem xét, chứ không phải là kết luận tự động về đạo văn. Các trường nội dung AI tùy chọn, nếu có, thể hiện một phân tích khác.

Tôi có thể tải xuống kết quả ở định dạng HTML và PDF không?

Phản hồi báo cáo có thể bao gồm một liên kết HTML có thể truy cập được trên trình duyệt và các mục trong mảng files đối với các biến thể PDF, tùy thuộc vào tài khoản và phản hồi API. Nên ưu tiên sử dụng URL báo cáo được trả về cho báo cáo cụ thể đó thay vì ghép nối thủ công ID và khóa truy cập.

Không được để lộ URL báo cáo có khóa xác thực trên các trang hoặc nhật ký được lập chỉ mục công khai. Việc truy cập và lưu giữ báo cáo tuân theo các quy tắc hiện hành về tài khoản, chia sẻ và lưu giữ dữ liệu; không nên sử dụng tuyên bố cũ rằng mọi báo cáo đều có sẵn mãi mãi. Xem hướng dẫn giải thích báo cáo độ tương đồng và thông tin xử lý dữ liệu.

Chức năng loại trừ và bộ lọc tìm kiếm hoạt động như thế nào?

Tài liệu của điểm cuối tạo báo cáo mô tả các bộ lọc tài liệu tham khảo và trích dẫn, lựa chọn Web và Lưu trữ (Storage), cùng các tùy chọn URL. Ví dụ: filter_references và filter_quotes là các bí danh được ghi lại để loại trừ nội dung danh sách tham khảo hoặc trích dẫn; search_web và search_storage chọn các bộ sưu tập nguồn.

Tài liệu API phân biệt giữa search_web_disable_urls và search_web_exclude_urls. Chức năng sau có thể giữ lại bằng chứng trùng khớp trong khi loại trừ các trang web đã chọn khỏi điểm số được tính toán. Điểm số thấp hơn sau khi áp dụng các ngoại lệ không có nghĩa là văn bản gốc đã thay đổi hoặc trở nên độc đáo hơn.

Sử dụng hướng dẫn bộ lọc tìm kiếm để giải thích kết quả. Kiểm tra cài đặt văn bản không dùng chữ Latinh và văn bản đa ngôn ngữ trước khi bật bộ lọc chỉ dành cho ký tự Latinh.

Tôi có thể tải lên và truy vấn dữ liệu từ Private Storage như thế nào?

Private Storage là một bộ sưu tập tùy chọn do khách hàng kiểm soát, dùng để so sánh với các tài liệu đã được lập chỉ mục trước đó. Nó khác với lịch sử báo cáo. Hướng dẫn cũ hiển thị tuyến đường tải lên POST /api/v3/storage/create và tham chiếu đến trường trạng thái is_in_index; hãy xác nhận các thao tác này và quyền hạn của chúng trong tài liệu tham khảo API hiện tại của tài khoản.

Giao diện tải lên lưu trữ API PlagiarismSearch trước đó
Ví dụ cũ về tải tài liệu lên Storage. Việc lập chỉ mục không diễn ra tức thời trong mọi trường hợp; hãy kiểm tra trạng thái sẵn sàng trước khi tìm kiếm tài liệu vừa được tải lên.

Chỉ tải lên những tài liệu mà bạn được phép xử lý và lập chỉ mục. Việc thêm tài liệu vào Kho lưu trữ (Storage) khác với việc kiểm tra tính tương đồng của một tài liệu mới; tránh tự động lưu mọi văn bản đã gửi trừ khi quy trình làm việc yêu cầu rõ ràng.

API này có hỗ trợ quy trình làm việc dành cho đại lý bán lại và nhiều người dùng không?

Tài liệu cũ mô tả các tài khoản đại lý tạo hồ sơ khách hàng và phân bổ tài nguyên kiểm tra thông qua các tuyến API riêng cho đại lý. Những chức năng này phụ thuộc vào tài khoản và không nên được coi là có sẵn theo mặc định. Liên hệ services@plagiarismsearch.com để xác nhận quyền đại lý hiện hành, quyền truy cập endpoint và kế hoạch triển khai an toàn.

Tuyệt đối không sử dụng các ví dụ mật khẩu cũ làm mẫu cho môi trường vận hành thực tế. Hãy tạo thông tin đăng nhập duy nhất một cách an toàn, tránh trả về mật khẩu thô vào nhật ký hoặc máy khách, và xác nhận xem quy trình tạo và phân bổ khách hàng có còn sử dụng giao diện /api/v3/reseller-customers cũ hay không.

Tại sao tôi lại nhận được lỗi 400, lỗi xác thực hoặc kết quả đang chờ xử lý?

400 Bad Request

Trước tiên hãy kiểm tra phương thức HTTP: điểm cuối tạo báo cáo được ghi lại sử dụng POST. Xác thực tên trường, loại nội dung, kích thước tệp, các trường văn bản bắt buộc và phản hồi lỗi thực tế; lỗi HTTP 400 có thể do nhiều nguyên nhân.

Ảnh chụp màn hình API PlagiarismSearch cũ hơn minh họa lỗi HTTP 400 và phương thức yêu cầu.
Ví dụ về cách khắc phục sự cố hệ thống cũ. Nó minh họa một trường hợp không khớp phương thức có thể xảy ra, chứ không phải là lời giải thích chung cho mọi phản hồi 400.

401 / authentication error

Hãy xác nhận rằng tên người dùng và khóa API đang hoạt động và được gửi kèm với mỗi yêu cầu theo phương thức xác thực mà endpoint quy định. Xem trang API Credentials của tài khoản. Không đưa khóa bí mật vào JavaScript công khai hoặc chia sẻ qua ảnh chụp màn hình.

Hồ sơ vẫn đang chờ xử lý

Báo cáo đã gửi hoặc tài liệu lưu trữ (Storage) có thể chưa sẵn sàng. Hãy kiểm tra trạng thái báo cáo đã ghi hoặc trạng thái lập chỉ mục lưu trữ thay vì giả định thời gian hoàn thành cố định từ 0 đến 6 phút. Xử lý lỗi và các lần thử lại riêng biệt với các báo cáo đã hoàn thành.

Các nhà phát triển nên hướng đến đâu tiếp theo?

Đối với một tích hợp mới, hãy bắt đầu với Tài liệu API, xác nhận các tính năng tài khoản đã được kích hoạt, sau đó kiểm tra một mẫu nhỏ với văn bản thực và các nguồn khác biệt rõ ràng. Chỉ ghi lại siêu dữ liệu kỹ thuật an toàn để lưu giữ, bảo vệ thông tin đăng nhập API và so sánh phản hồi được trả về với lược đồ đã được ghi lại trước khi xây dựng báo cáo tự động.

Đối với các câu hỏi về quyền truy cập hoặc thiết lập, hãy liên hệ services@plagiarismsearch.com hoặc sử dụng Trung tâm trợ giúp. Trang API chống đạo văn công khai mô tả sản phẩm và các tùy chọn liên hệ.

Xây dựng một tích hợp tốt hơn

Hãy sử dụng quy trình API đã được ghi chép, bảo vệ thông tin đăng nhập của bạn và xác minh các phản hồi mà quá trình tích hợp của bạn dựa vào.