Cập nhật cài đặt trung tâm trợ giúp bằng API Notiondesk

API Notiondesk cho phép bạn thay đổi cài đặt trung tâm trợ giúp từ mã nguồn: lập chỉ mục công cụ tìm kiếm, tiêu đề và mô tả trang bằng từng ngôn ngữ, tối ưu hóa AI, biểu mẫu liên hệ và nhật ký thay đổi. Sử dụng nó để áp dụng cùng một cấu hình cho nhiều trung tâm trợ giúp hoặc để quản lý cài đặt theo phiên bản.

Ngôn ngữ và dịch tự động có bài viết riêng: Quản lý ngôn ngữ và dịch tự động với API Notiondesk . Màu sắc, phông chữ và bố cục nằm trong bài viết Tùy chỉnh thương hiệu và chủ đề trung tâm trợ giúp với API Notiondesk .

Cách thức cập nhật cài đặt hoạt động

Mọi tuyến đường trên trang này đều tuân theo cùng một quy tắc:

• Chỉ gửi những gì bạn thay đổi. Trường nào bạn bỏ qua sẽ giữ nguyên giá trị hiện tại.

• Câu trả lời là 204 No Content , không có nội dung, ngay cả khi không có gì thay đổi. Đọc trạng thái mới với GET /sites/{site_id}, như được mô tả trong phần Đọc trung tâm trợ giúp của bạn bằng API Notiondesk .

• Gửi các giá trị boolean JSON. Chỉ chấp nhận true hoặc false: các giá trị 0 và "false" được đọc là true.

• Các trường không xác định bị từ chối với mã lỗi 400 validation_error, và không có gì thay đổi.

• Việc thử lại an toàn với Idempotency-Key. Xem Xử lý lỗi API Notiondesk, giới hạn tỷ lệ và thử lại .

Lập chỉ mục công cụ tìm kiếm, tiêu đề trang và mô tả

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/content" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"seo_indexing_enabled": true, "items": [{"locale": "fr", "page_title": "Centre d aide Example", "page_description": "Toutes les réponses sur Example"}]}'

Mỗi đối tượng trong items:

Một đối tượng chỉ thay đổi các trường mà nó chứa, và ngôn ngữ bạn không sử dụng trong items sẽ giữ nguyên tiêu đề và mô tả của nó. items không thể thêm hoặc xóa ngôn ngữ.

Lỗi ở một ngôn ngữ sẽ được ghi rõ trong đường dẫn trường, ví dụ: items[fr].page_title.

seo_indexing_enabled: false Yêu cầu các công cụ tìm kiếm ngừng lập chỉ mục toàn bộ trung tâm trợ giúp của bạn. Xem Ngăn chặn các công cụ tìm kiếm thu thập thông tin và lập chỉ mục trung tâm trợ giúp của bạn .

Tối ưu hóa AI

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/ai-optimization" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"llms_txt_enabled": true, "markdown_export_enabled": true, "ai_contextual_menu_enabled": true}'

Kế hoạch của bạn phải bao gồm tối ưu hóa bằng AI. Tìm hiểu chức năng của từng tính năng trong phần Thiết lập tối ưu hóa AI trong trung tâm trợ giúp và Giới thiệu về tối ưu hóa GEO/AI .

Biểu mẫu liên hệ

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/contact-form" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

• API chỉ bật hoặc tắt biểu mẫu, không hơn không kém. Các địa chỉ nhận dữ liệu được thiết lập trong bảng điều khiển. Nội dung có destination_emails sẽ trả về mã lỗi 400 validation_error và không thay đổi gì cả.

• Biểu mẫu chỉ hoạt động khi có địa chỉ đã lưu. Việc bật biểu mẫu cho trung tâm trợ giúp mà không có địa chỉ sẽ trả về lỗi 400 validation_error cho destination_emails. Trước tiên, hãy thiết lập địa chỉ trong bảng điều khiển. Việc tắt biểu mẫu không cần địa chỉ.

• Kế hoạch của bạn phải bao gồm khả năng tùy chỉnh nâng cao, thậm chí cả việc tắt biểu mẫu.

Nhật ký thay đổi

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/changelog" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true, "reactions_enabled": true, "changelog_categories": [{"category_id": "2984612035", "color": "blue_sky"}]}'

Mỗi đối tượng trong changelog_categories đều có category_id bắt buộc, id của một trong các bộ sưu tập của bạn và color tùy chọn với tối đa 255 ký tự.

changelog_categories Thay thế toàn bộ tập hợp. Một tập hợp bạn bỏ sót sẽ không còn là tập hợp nhật ký thay đổi nữa và tất cả chúng sẽ bị xóa. Hãy đọc từ đầu khi bạn chỉ muốn thêm một tập hợp. Tập hợp này chứa tối đa 100 tập hợp.[]changelog_categoriesGET /sites/{site_id}

Gói dịch vụ của bạn phải bao gồm nhật ký thay đổi. Nếu bạn bật đăng ký nhận email nhưng gói dịch vụ của bạn không còn bao gồm thông báo email về nhật ký thay đổi, mọi yêu cầu đến tuyến đường này sẽ trả về mã lỗi 403 permission_denied cho đến khi nó gửi mã lỗi "email_subscriptions_enabled": false.

Tìm hiểu thêm trong phần Thiết lập nhật ký thay đổi trên trung tâm trợ giúp của bạn và Cách bật đăng ký nhận email cho nhật ký thay đổi của bạn .

Lỗi

Xem các lỗi API, giới hạn tốc độ và số lần thử lại của Handle Notiondesk để biết phạm vi lỗi và các mã khác.

Câu hỏi thường gặp

Tiếp theo là gì?

• Tùy chỉnh thương hiệu và giao diện trung tâm trợ giúp bằng API Notiondesk

• Quản lý việc tích hợp trung tâm trợ giúp với API Notiondesk

• Quản lý ngôn ngữ và dịch tự động bằng API Notiondesk