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

API Notiondesk cho phép bạn liệt kê, cấu hình và tắt các tích hợp bên thứ ba của trung tâm trợ giúp: các nhà cung cấp phân tích, trò chuyện trực tuyến và quản lý thẻ. Sử dụng nó để triển khai cùng một thiết lập phân tích hoặc trò chuyện trên nhiều trung tâm trợ giúp chỉ bằng một tập lệnh.

Việc cấu hình và vô hiệu hóa các nhà cung cấp cần một kế hoạch bao gồm cả việc tích hợp.

Mỗi nhà cung cấp đều tải một đoạn mã bên thứ ba trên mọi trang của trung tâm trợ giúp của bạn. Một vùng chứa Google Tag Manager chạy bất cứ thứ gì chủ sở hữu của nó xuất bản, và Plausible hoặc Umami quyết định nơi đoạn mã phân tích được tải từ đâu. Đó là lý do tại sao việc thay đổi tích hợp cần có phạm vi. Chỉ cấp khóa cho các tích hợp mà bạn tin tưởng.proxy_urladminadmin

Các nhà cung cấp được hỗ trợ

Mỗi giá trị là một chuỗi có tối đa 255 ký tự. Không có giá trị nào là bí mật: mỗi giá trị là một mã định danh mà tập lệnh của nhà cung cấp cần trên trang. Notiondesk kiểm tra định dạng nhưng không kiểm tra chính mã định danh đó với nhà cung cấp.

Liệt kê các tích hợp của bạn

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "type": "plausible-analytics",
      "settings": {"domain": "help.example.com", "proxy_url": null},
      "enabled": true
    },
    {
      "type": "crisp",
      "settings": {"app_id": "7d1c9a2e-5b4f-4e3a-9c8d-2f1e0a9b8c7d"},
      "enabled": false
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Danh sách này bao gồm các nhà cung cấp đã bị tắt, không theo thứ tự cụ thể nào, và luôn vừa vặn trong một phản hồi. Nhà cung cấp chưa từng được cấu hình sẽ không có trong danh sách.

Cấu hình nhà cung cấp

Gửi các trường của nhà cung cấp đến đường dẫn của nó. Tuyến đường trả lời 200 OK với sự tích hợp.

curl -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/plausible-analytics" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"domain": "help.example.com"}'

{
  "type": "plausible-analytics",
  "settings": {"domain": "help.example.com", "proxy_url": null},
  "enabled": true
}

• Việc cập nhật luôn kích hoạt nhà cung cấp. Không có trường enabled: để tắt nhà cung cấp, hãy sử dụng phương thức vô hiệu hóa.

• Trường bạn bỏ trống sẽ giữ nguyên giá trị đã lưu. Để bật lại nhà cung cấp đã cấu hình mà không thay đổi nó, hãy gửi {}.

• Để xóa máy chủ proxy, hãy gửi "proxy_url": null.

• Mỗi lần cập nhật sẽ làm mới toàn bộ trung tâm trợ giúp, xóa các trang đã lưu trong bộ nhớ cache và xây dựng lại từng trang.

Lưu ý: Giá trị được lưu trước khi các định dạng hiện tại được áp dụng, chẳng hạn như ID Google Analytics hoặc một giá trị không hợp lệ, sẽ không được xác thực. Cho đến khi bạn gửi một giá trị hợp lệ cho trường đó, mọi cập nhật của nhà cung cấp đó đều trả về lỗi 400, bao gồm cả lỗi này.UA-proxy_urlhttpsvalidation_error{}

Tắt nhà cung cấp

Tuyến đường trả lời 204 No Content và trung tâm trợ giúp của bạn ngừng tải nhà cung cấp. Cài đặt của nó được giữ nguyên, vì vậy danh sách vẫn hiển thị nó với enabled: false, và {} được gửi đến tuyến đường cập nhật của nó sẽ bật lại nó.

Việc tắt một nhà cung cấp đã bị tắt hoặc chưa từng được cấu hình cũng trả về lỗi 204 và không thay đổi gì cả, vì vậy việc thử lại luôn an toàn.

Lỗi

curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/google-tag-manager/disable" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

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ì?

• Nhận phân tích trung tâm trợ giúp với API Notiondesk

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

• Xác thực với API Notiondesk bằng khóa API.