API REST Notiondesk cho phép mã của riêng bạn vận hành các trung tâm trợ giúp. Bạn có thể liệt kê các trung tâm trợ giúp, đọc các bài viết, bộ sưu tập và nhật ký thay đổi của chúng, quản lý chuyển hướng trang, thay đổi cài đặt và thương hiệu, lấy dữ liệu phân tích và phản hồi của người đọc, và kích hoạt đồng bộ hóa từ Notion.
Bài viết này giải thích API Notiondesk có thể làm được gì, ai có thể sử dụng nó và cách thực hiện yêu cầu đầu tiên của bạn chỉ trong vài phút.
Những việc bạn có thể làm với API Notiondesk
| Nhiệm vụ | Ví dụ | Hướng dẫn |
|---|---|---|
| Hãy đọc hướng dẫn tại các trung tâm trợ giúp. | Liệt kê tất cả các trung tâm trợ giúp trong không gian làm việc của bạn và ngôn ngữ của chúng. | Hãy đọc hướng dẫn tại các trung tâm trợ giúp. |
| Đọc nội dung | Xuất tất cả bài viết dưới dạng Markdown hoặc liệt kê các mục trong nhật ký thay đổi của bạn. | Đọc các bài viết, bộ sưu tập và mục nhật ký thay đổi |
| Xuất bản các thay đổi trong Notion | Sau khi chỉnh sửa Notion, hãy đồng bộ hóa trung tâm trợ giúp của bạn từ quy trình CI. | Kích hoạt tính năng đồng bộ hóa Notion. |
| Quản lý chuyển hướng | Nhập hàng trăm liên kết chuyển hướng sau khi chuyển đổi từ trung tâm trợ giúp khác. | Quản lý việc chuyển hướng trang |
| Thay đổi ngôn ngữ | Thêm ngôn ngữ hoặc bật dịch tự động | Quản lý ngôn ngữ và dịch tự động |
| Thay đổi cài đặt | Cập nhật tiêu đề SEO, llms.txt, biểu mẫu liên hệ hoặc nhật ký thay đổi | Cập nhật cài đặt trung tâm trợ giúp |
| Thay đổi thương hiệu | Áp dụng màu sắc và chủ đề thương hiệu của bạn cho nhiều trung tâm hỗ trợ khách hàng. | Tùy chỉnh thương hiệu và chủ đề |
| Quản lý các tích hợp | Cấu hình Google Analytics, Plausible, Intercom hoặc Crisp. | Quản lý các tích hợp |
| Phân tích kéo | Chuyển thông tin khách truy cập, kết quả tìm kiếm và bài viết hàng đầu đến công cụ BI của bạn. | Nhận phân tích trung tâm trợ giúp |
| Đọc phản hồi | Mỗi sáng, hãy gửi phản hồi tiêu cực về các bài báo lên Slack. | Xuất phản hồi của người đọc |
Để có các tập lệnh sẵn sàng sử dụng, hãy xem Tự động hóa các tác vụ trung tâm trợ giúp thông thường bằng API Notiondesk .
Ai có thể sử dụng API Notiondesk
- Gói dịch vụ: Quyền truy cập API được bao gồm trong các gói Doanh nghiệp.
- Tạo khóa: Chủ sở hữu không gian làm việc và Quản trị viên tạo khóa API trong bảng điều khiển.
- Quyền hạn: Một khóa hoặc ứng dụng không bao giờ có thể làm nhiều hơn những gì người sở hữu nó có thể làm trong không gian làm việc của bạn. Xem Xác thực với API Notiondesk bằng khóa API .
Thực hiện yêu cầu API Notiondesk đầu tiên của bạn
1. Tạo khóa API
Trong bảng điều khiển Notiondesk của bạn, hãy mở Cài đặt , sau đó chọn Nhà phát triển > Khóa API và nhấp vào Tạo khóa . Đặt nhãn cho khóa, chọn phạm vi đọc và sao chép khóa khi nó được hiển thị. Khóa bắt đầu bằng nd_wsk_ và chỉ được hiển thị một lần.
Lưu trữ nó trong một biến môi trường:
2. Liệt kê các trung tâm trợ giúp của bạn
Phản hồi này liệt kê tất cả các trung tâm trợ giúp trong không gian làm việc của bạn:
3. Liệt kê các bài viết của trung tâm trợ giúp
Vậy là xong! Bạn đang đọc trung tâm trợ giúp từ mã nguồn.
Notiondesk Kiến thức cơ bản về API
export NOTIONDESK_API_KEY="nd_wsk_..."curl "<https://api.notiondesk.so/sites>" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"{
"object": "list",
"data": [
{
"id": "c74781f6-1aea-4e17-ab23-bbb8b4d174b6",
"full_domain": "help.example.com",
"enabled": true,
"default_locale": "en",
"locales": ["en", "fr"]
}
],
"has_more": false,
"next_cursor": null
}curl "<https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/articles?page_size=10>" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"| Đề tài | Những điều cần biết |
|---|---|
| URL cơ sở | https://api.notiondesk.so |
| Xác thực | __ĐÃ BẢO LƯU_108__. Xem khóa API và OAuth |
| Phạm vi | read, write, sync và admin. Mỗi tuyến đường yêu cầu một |
| Phiên bản | Tiêu đề nd-version tùy chọn |
| Định dạng | Nội dung yêu cầu và phản hồi JSON với tên trường dạng snake_case. |
| Đánh số trang | Dựa trên con trỏ: page_size (từ 1 đến 100, mặc định là 20) và cursor. Xem Yêu cầu phân trang và phiên bản . |
| Lỗi | Một gói JSON với thông tin code có thể đọc được bằng máy. Xem Xử lý lỗi, giới hạn tỷ lệ và thử lại. |
Notiondesk API hay Workspace MCP?
Notiondesk cung cấp hai cách để vận hành trung tâm trợ giúp của bạn bên ngoài bảng điều khiển. Chúng truy cập cùng một tính năng thông qua các cổng khác nhau.
| Notiondesk API REST | Không gian làm việc MCP | |
|---|---|---|
| Ai gọi nó vậy? | Mã của bạn: các tập lệnh, quy trình CI, công cụ nội bộ, ứng dụng đối tác. | Một trợ lý AI như Claude, ChatGPT, Cursor hoặc VS Code. |
| Cách đăng nhập | Khóa API không gian làm việc hoặc mã thông báo truy cập OAuth | OAuth, thông qua ứng dụng khách AI của bạn |
| Tốt nhất cho | Tự động hóa có thể lặp lại và mang tính xác định | Hoạt động đối thoại: "Tìm những bài viết mà độc giả không thích và đề xuất cách khắc phục" |
Điểm cuối API Notiondesk
| Phương pháp | Con đường | Phạm vi | Hướng dẫn |
|---|---|---|---|
GET | /sites | read | Trung tâm trợ giúp |
GET | /sites/{site_id} | read | Trung tâm trợ giúp |
GET | /sites/{site_id}/sync-status | read | Trung tâm trợ giúp |
GET | /sites/{site_id}/articles | read | Nội dung |
GET | /sites/{site_id}/articles/{article_id} | read | Nội dung |
GET | /sites/{site_id}/categories | read | Nội dung |
GET | /sites/{site_id}/categories/{category_id} | read | Nội dung |
GET | /sites/{site_id}/changelog | read | Nội dung |
POST | /sites/{site_id}/sync | sync | Đồng bộ hóa |
POST | /sites/{site_id}/articles/{article_id}/sync | sync | Đồng bộ hóa |
POST | /sites/{site_id}/categories/{category_id}/sync | sync | Đồng bộ hóa |
PATCH | /sites/{site_id}/settings/auto-sync | sync | Đồng bộ hóa |
GET | /sites/{site_id}/page-redirects | read | Chuyển hướng |
POST | /sites/{site_id}/page-redirects | write | Chuyển hướng |
PATCH | /sites/{site_id}/page-redirects/{redirect_id} | write | Chuyển hướng |
DELETE | /sites/{site_id}/page-redirects/{redirect_id} | admin | Chuyển hướng |
PATCH | /sites/{site_id}/settings/supported-languages | write | Ngôn ngữ |
PATCH | /sites/{site_id}/settings/auto-translate | write | Ngôn ngữ |
PATCH | /sites/{site_id}/settings/content | write | Cài đặt |
PATCH | /sites/{site_id}/settings/ai-optimization | write | Cài đặt |
PATCH | /sites/{site_id}/settings/contact-form | write | Cài đặt |
PATCH | /sites/{site_id}/settings/changelog | write | Cài đặt |
GET | /sites/{site_id}/settings/customize | read | Xây dựng thương hiệu |
PATCH | /sites/{site_id}/settings/customize | admin | Xây dựng thương hiệu |
GET | /sites/{site_id}/themes | read | Xây dựng thương hiệu |
GET | /sites/{site_id}/integrations | read | Tích hợp |
PATCH | /sites/{site_id}/integrations/{type} | admin | Tích hợp |
POST | /sites/{site_id}/integrations/{type}/disable | admin | Tích hợp |
GET | /sites/{site_id}/analytics/{report} | read | Phân tích |
GET | /sites/{site_id}/feedback | read | Nhận xét |
Câu hỏi thường gặp
Tôi có thể tạo hoặc chỉnh sửa bài viết bằng API Notiondesk không?
Không. Các bài viết, bộ sưu tập và mục nhật ký thay đổi được viết trong Notion, và mỗi lần đồng bộ hóa sẽ ghi đè lên những gì Notiondesk lưu trữ. Chỉnh sửa trang Notion bằng trình chỉnh sửa Notion hoặc API Notion, sau đó gọi trình kích hoạt đồng bộ hóa để xuất bản thay đổi.
Một khóa API có dùng được cho tất cả các trung tâm trợ giúp của tôi không?
Đúng vậy. Khóa API của không gian làm việc có hiệu lực đối với mọi trung tâm trợ giúp trong không gian làm việc đó. Mỗi yêu cầu sẽ chỉ định tên trung tâm trợ giúp trong đường dẫn của nó, ví dụ: /sites/{site_id}/articles.
Tôi có thể tìm site_id của trung tâm trợ giúp ở đâu?
site_id của trung tâm trợ giúp ở đâu?Gọi GET /sites để liệt kê các trung tâm trợ giúp của bạn cùng với id. Đây cũng là mã định danh sau /s/ trong thanh địa chỉ của bảng điều khiển.