Tài liệu tham khảo API

Mọi điểm cuối API Notiondesk cùng với các tham số, phản hồi và ví dụ mã.

API REST Notiondesk cho phép bạn vận hành trung tâm trợ giúp của mình từ mã nguồn. Đọc bài viết, bộ sưu tập và các mục nhật ký thay đổi, quản lý chuyển hướng trang, cập nhật cài đặt, thương hiệu và tích hợp, xuất 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ạn vẫn viết nội dung của mình trong Notion: API đọc và đồng bộ hóa nội dung đó, chứ không chỉnh sửa.

URL cơ sở

Gửi mọi yêu cầu đến https://api.notiondesk.so. Đường dẫn điểm cuối bắt đầu bằng /sites, và các yêu cầu và phản hồi sử dụng định dạng JSON.

Xác thực

Mỗi yêu cầu đều mang theo một mã thông báo xác thực trong tiêu đề Authorization:

curl https://api.notiondesk.so/sites \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY"
  • Khóa API : dành cho các tập lệnh, công việc theo lịch trình và CI của riêng bạn. Chủ sở hữu không gian làm việc hoặc Quản trị viên tạo khóa này trong Cài đặt > Nhà phát triển > Khóa API. Các khóa bắt đầu bằng nd_wsk_ và hoạt động cho mọi trung tâm trợ giúp trong không gian làm việc. Xem Xác thực với API Notiondesk bằng khóa API .

Mỗi endpoint cần một phạm vi: read, write, sync hoặc admin. Trang của mỗi endpoint sẽ hiển thị phạm vi đó.

Ví dụ mã

Mỗi trang chi tiết về điểm cuối hệ thống đều liệt kê các tham số, nội dung yêu cầu và phản hồi, kèm theo các mẫu mã sẵn sàng để sao chép bằng cURL, JavaScript và Python.

Hướng dẫn

  • Hướng dẫn bắt đầu : Khóa API, OAuth, phân trang và phiên bản, lỗi và giới hạn số lượt truy cập, và các ví dụ.
  • Webhooks : nhận một yêu cầu trên máy chủ của bạn khi có sự kiện xảy ra trong Notiondesk.