APIリファレンス

すべての Notiondesk API エンドポイントとそのパラメータ、レスポンス、コードサンプル。

Notiondesk REST API を使用すると、コードからヘルプセンターを運用できます。記事、コレクション、変更履歴エントリの読み取り、ページのリダイレクト管理、設定、ブランディング、統合の更新、分析データと読者からのフィードバックのエクスポート、Notion からの同期のトリガーなどが可能です。コンテンツの作成は引き続き Notion で行います。API はコンテンツを読み込んで同期するだけで、編集は行いません。

ベースURL

すべてのリクエストはhttps://api.notiondesk.soに送信してください。エンドポイントパスは/sitesで始まり、リクエストとレスポンスはJSON形式を使用します。

認証

すべてのリクエストには、Authorization ヘッダーにベアラートークンが含まれています。

curl https://api.notiondesk.so/sites \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY"
  • API キー: 独自のスクリプト、スケジュールされたジョブ、および CI に使用します。ワークスペースの所有者または管理者が、[設定] > [開発者] > [API キー] で作成します。キーは nd_wsk_ で始まり、ワークスペース内のすべてのヘルプ センターで使用できます。APIキーを使用して Notiondesk API で認証する方法を参照してください。

各エンドポイントには、read、write、sync、またはadminのいずれかのスコープが必要です。各エンドポイントのページには、どのスコープが適用されるかが表示されます。

コードサンプル

各エンドポイントのページには、パラメータ、リクエストボディ、レスポンスが一覧表示され、cURL、JavaScript、Pythonのコードサンプルがそのままコピーできる形で掲載されています。

ガイド

  • 入門ガイド:APIキー、OAuth、ページネーションとバージョン管理、エラーとレート制限、および使用例。
  • Webhook : Notiondesk で何かが発生したときに、サーバーでリクエストを受け取ります。