Cài đặt & cộng tác
Kết nối với phần mềm khác
Dùng khoá API để truy cập và webhook để nhận thông báo cập nhật.
Trong bài này
Khi nào cần tích hợp?
Bạn chỉ cần mục Tích hợp nếu có phần mềm, bot hoặc hệ thống muốn làm việc với 2novel. Dịch và biên tập trực tiếp trong ứng dụng không yêu cầu tạo khoá API hay webhook.
Tạo khoá API của 2novel
Vào Cài đặt → Tích hợp → Khoá API của 2novel. Quyền truy cập phụ thuộc không gian làm việc của bạn.
- Tạo khoá và đặt tên theo phần mềm sử dụng.
- Sao chép khoá ngay khi được hiển thị và lưu trong kho bí mật hoặc cấu hình riêng của hệ thống nhận. Không đặt khoá trong mã frontend công khai.
- Dùng tài liệu API để thực hiện các yêu cầu đã xác thực.
- Thu hồi khoá khi không dùng nữa. Nếu mất khoá, tạo khoá mới; không thể xem lại khoá cũ.
Nhận thông báo qua webhook
Webhook là thông báo có tác phẩm vừa cập nhật, không chứa toàn bộ nội dung chương. Phần mềm nhận dùng API để lấy dữ liệu cần thiết.
- Mở Thông báo webhook và tạo địa chỉ nhận HTTPS công khai do bạn quản lý.
- Chọn các loại sự kiện mà hệ thống nhận cần xử lý.
- Lưu khoá ký được hiển thị một lần và cấu hình kiểm tra chữ ký tại hệ thống nhận.
- Dùng Gửi thử, kiểm tra mã phản hồi và log của hệ thống nhận. Phản hồi thành công không tự chứng minh chữ ký đã được kiểm tra.
- Theo dõi trạng thái gửi; tạm dừng khi bảo trì và tiếp tục khi hệ thống nhận sẵn sàng.
Đổi khoá ký và xử lý lỗi
Đổi khoá ký làm hệ thống nhận cần dùng khoá mới; cập nhật nó ngay sau khi đổi. Xoá webhook sẽ dừng các lần gửi tiếp theo. Xem tài liệu API để triển khai kiểm tra chữ ký trên phần thân yêu cầu gốc và xử lý phản hồi đúng hợp đồng.