api
Bắt đầu sử dụng API REST NotiondeskSử dụng API REST Notiondesk để đọc nội dung trung tâm trợ giúp, quản lý chuyển hướng và cài đặt, lấy dữ liệu phân tích và kích hoạt đồng bộ hóa Notion từ mã.
Xác thực với API Notiondesk bằng khóa API.Tạo khóa API Notiondesk, chọn phạm vi đọc, ghi, đồng bộ hoặc quản trị, và xác thực các yêu cầu API REST bằng mã thông báo bearer. Có thể xoay vòng hoặc thu hồi bất cứ lúc nào.
Kết nối ứng dụng của bạn với Notiondesk bằng OAuthXây dựng ứng dụng OAuth Notiondesk: đăng ký máy khách, chạy quy trình mã ủy quyền OAuth 2.0 với PKCE, mã thông báo làm mới và gọi API REST.
Phân trang và phiên bản Notiondesk Yêu cầu APIDuyệt qua danh sách API Notiondesk bằng page_size và cursor, ghim một phiên bản bằng tiêu đề nd-version và sử dụng tên trường snake_case.
Xử lý các lỗi API, giới hạn tỷ lệ và các lần thử lại của NotiondeskMã lỗi API Notiondesk và phạm vi, giới hạn tốc độ 120 lượt đọc và 20 lượt ghi mỗi phút, Retry-After và các lần thử lại an toàn với Idempotency-Key.
Đọc các trung tâm trợ giúp của bạn với API NotiondeskLiệt kê các trung tâm trợ giúp Notiondesk của bạn, đọc tên miền, ngôn ngữ và cài đặt của chúng, đồng thời kiểm tra trạng thái đồng bộ hóa Notion theo lịch trình bằng API Notiondesk.
Đọc các bài viết, bộ sưu tập và mục nhật ký thay đổi bằng API NotiondeskĐọc các bài viết và bộ sưu tập của trung tâm trợ giúp Notiondesk dưới dạng markdown, bằng bất kỳ ngôn ngữ nào, với trạng thái đồng bộ và liệt kê các mục nhật ký thay đổi thông qua API REST.
Trigger Notion đồng bộ với API NotiondeskĐồng bộ hóa trung tâm trợ giúp Notiondesk của bạn từ Notion thông qua API: kích hoạt đồng bộ hóa trang web, bộ sưu tập hoặc bài viết, và bật hoặc tắt tính năng đồng bộ hóa theo lịch trình.
Quản lý việc chuyển hướng trang bằng API NotiondeskTạo, liệt kê, cập nhật và xóa các liên kết chuyển hướng trang trung tâm trợ giúp Notiondesk thông qua API REST. Nhập hàng loạt các URL cũ sau khi di chuyển.
Quản lý ngôn ngữ và dịch tự động bằng API NotiondeskThêm hoặc xóa ngôn ngữ trung tâm trợ giúp, đặt ngôn ngữ mặc định và bật hoặc tắt tính năng dịch tự động bằng AI thông qua API REST.
Cập nhật cài đặt trung tâm trợ giúp bằng API NotiondeskCập nhật cài đặt trung tâm trợ giúp Notiondesk thông qua API REST: lập chỉ mục SEO, tiêu đề trang, xuất llms.txt và markdown, biểu mẫu liên hệ và nhật ký thay đổi.
Tùy chỉnh thương hiệu và giao diện trung tâm trợ giúp bằng API NotiondeskCập nhật thương hiệu trung tâm trợ giúp Notiondesk thông qua API REST: màu sắc, phông chữ, bố cục, liên kết đầu trang và chân trang, hiển thị tìm kiếm và chủ đề.
Quản lý việc tích hợp trung tâm trợ giúp với API NotiondeskCấu hình Google Analytics, Plausible, Umami, Intercom, Crisp, Help Scout và Google Tag Manager trên trung tâm trợ giúp của bạn thông qua API REST.
Nhận phân tích trung tâm trợ giúp với API NotiondeskXuất dữ liệu phân tích trung tâm trợ giúp Notiondesk thông qua API REST: khách truy cập, lượt xem bài viết, tìm kiếm hàng đầu, tìm kiếm không có kết quả và phản hồi của người đọc.
Xuất phản hồi của người đọc bằng API NotiondeskXuất phản hồi bài viết Notiondesk thông qua API REST: phản hồi của người đọc, câu trả lời tiếp theo, tin nhắn và tệp đính kèm, mới nhất trước.
Tự động hóa các tác vụ thường gặp trong trung tâm trợ giúp bằng API NotiondeskVí dụ về API: đồng bộ từ GitHub Actions, sao lưu bài viết dưới dạng markdown, đăng phản hồi lên Slack và báo cáo các tìm kiếm không có kết quả.