Notiondesk REST API を使い始めましょう

Notiondesk REST API を使用すると、ヘルプセンターのコンテンツの読み取り、リダイレクトと設定の管理、分析データの取得、コードからの Notion 同期のトリガーを行うことができます。

2 分で読めます

Notiondesk REST API を使用すると、独自のコードでヘルプセンターを操作できます。ヘルプセンターの一覧表示、記事、コレクション、変更履歴の閲覧、ページリダイレクトの管理、設定やブランディングの変更、分析データや読者からのフィードバックの取得、Notion からの同期のトリガーなどが可能です。

この記事では、Notiondesk API で何ができるのか、誰が利用できるのか、そして最初のリクエストを数分で行う方法について説明します。

Notiondesk API でできること

タスク例ガイド
ヘルプセンターをご覧くださいワークスペース内のすべてのヘルプセンターとその言語を一覧表示します。ヘルプセンターをご覧ください
コンテンツを読むすべての記事をマークダウン形式でエクスポートするか、変更履歴エントリを一覧表示します。記事、コレクション、変更履歴エントリを読む
Notionの変更を公開するNotionを編集した後、CIパイプラインからヘルプセンターを同期します。 Notionの同期をトリガーする
リダイレクトを管理する別のヘルプセンターから移行した後、数百件のリダイレクトをインポートするページのリダイレクトを管理する
言語を変更する言語を追加するか、自動翻訳をオンにする言語管理と自動翻訳
設定を変更するSEOタイトル、llms.txt、お問い合わせフォーム、または変更履歴を更新してください。ヘルプセンターの設定を更新する
ブランドを変更する複数のヘルプセンターにブランドカラーとテーマを適用するブランドとテーマをカスタマイズ
統合を管理するGoogle Analytics、Plausible、Intercom、またはCrispを設定する統合を管理する
プル分析訪問者、検索、人気記事をBIツールに送信します。ヘルプセンターの分析を取得する
フィードバックを読む毎朝、記事に対する否定的な反応をSlackに送信する読者からのフィードバックをエクスポートする

すぐに使えるスクリプトについては、 「Notiondesk API を使用して一般的なヘルプセンターのタスクを自動化する」を参照してください。

Notiondesk API は誰が使用できますか?

  • プラン:エンタープライズプランにはAPIアクセスが含まれています。
  • キーの作成:ワークスペースの所有者と管理者は、ダッシュボードでAPIキーを作成します。

最初のNotiondesk APIリクエストを実行してください

1. APIキーを作成する

Notiondesk ダッシュボードで、 [設定] 、 [開発者] > [API キー] の順に開き、 [キーの作成]をクリックします。ラベルを付け、読み取り範囲を選択し、表示されたキーをコピーします。キーは nd_wsk_ で始まり、一度だけ表示されます。

環境変数に保存してください。

2. ヘルプセンターの一覧を表示する

応答には、ワークスペース内のすべてのヘルプセンターが表示されます。

3. ヘルプセンターの記事一覧を表示する

これで完了です!あなたはコードからヘルプセンターを読み込んでいます。

Notiondesk 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"
トピック知っておくべきこと
ベースURLhttps://api.notiondesk.so
認証Authorization: Bearer <key or access token>。 APIキーとOAuthを参照してください。
スコープread、write、sync、admin。各ルートには1つ必要です。
バージョン管理オプションの nd-version ヘッダー
形式スネークケースのフィールド名を使用したJSONリクエストおよびレスポンスボディ
ページネーションカーソルベース: page_size (1~100、デフォルトは20) および cursor。ページネーションとバージョン要求を参照してください。
エラー機械可読なcodeを含むJSONエンベロープ1つ。エラー、レート制限、再試行の処理を参照してください。

Notiondesk API または Workspace MCP ですか?

Notiondesk では、ダッシュボード以外からヘルプセンターを操作する方法が 2 つ用意されています。どちらも異なる方法で同じ機能にアクセスできます。

Notiondesk REST API Workspace MCP
誰がそれを呼ぶのかあなたのコード:スクリプト、CIパイプライン、内部ツール、パートナーアプリClaude、ChatGPT、Cursor、VS CodeなどのAIアシスタント
サインイン方法ワークスペースAPIキー、またはOAuthアクセストークンOAuth、AIクライアント経由
最適再現可能で決定論的な自動化対話型の作業:「読者が気に入らない記事を見つけて、改善策を提案する」

Notiondesk APIエンドポイント

方法パス範囲ガイド
GET/sitesreadヘルプセンター
GET/sites/{site_id}readヘルプセンター
GET/sites/{site_id}/sync-statusreadヘルプセンター
GET/sites/{site_id}/articlesreadコンテンツ
GET/sites/{site_id}/articles/{article_id}readコンテンツ
GET/sites/{site_id}/categoriesreadコンテンツ
GET/sites/{site_id}/categories/{category_id}readコンテンツ
GET/sites/{site_id}/changelogreadコンテンツ
POST/sites/{site_id}/syncsync同期
POST/sites/{site_id}/articles/{article_id}/syncsync同期
POST/sites/{site_id}/categories/{category_id}/syncsync同期
PATCH/sites/{site_id}/settings/auto-syncsync同期
GET/sites/{site_id}/page-redirectsreadリダイレクト
POST/sites/{site_id}/page-redirectswriteリダイレクト
PATCH/sites/{site_id}/page-redirects/{redirect_id}writeリダイレクト
DELETE/sites/{site_id}/page-redirects/{redirect_id}adminリダイレクト
PATCH/sites/{site_id}/settings/supported-languageswrite言語
PATCH/sites/{site_id}/settings/auto-translatewrite言語
PATCH/sites/{site_id}/settings/contentwrite設定
PATCH/sites/{site_id}/settings/ai-optimizationwrite設定
PATCH/sites/{site_id}/settings/contact-formwrite設定
PATCH/sites/{site_id}/settings/changelogwrite設定
GET/sites/{site_id}/settings/customizereadブランディング
PATCH/sites/{site_id}/settings/customizeadminブランディング
GET/sites/{site_id}/themesreadブランディング
GET/sites/{site_id}/integrationsread統合
PATCH/sites/{site_id}/integrations/{type}admin統合
POST/sites/{site_id}/integrations/{type}/disableadmin統合
GET/sites/{site_id}/analytics/{report}read分析
GET/sites/{site_id}/feedbackreadフィードバック

よくある質問

Notiondesk API を使用して記事を作成または編集できますか?

いいえ。記事、コレクション、変更履歴エントリはNotionに書き込まれ、同期のたびにNotiondeskに保存されている内容が上書きされます。NotionエディターまたはNotion APIを使用してNotionページを編集し、同期トリガーを呼び出して変更を公開してください。

1つのAPIキーで全てのヘルプセンターに対応できますか?

はい。ワークスペースAPIキーは、そのワークスペース内のすべてのヘルプセンターで使用できます。各リクエストのパスには、ヘルプセンター名が含まれます。たとえば、/sites/{site_id}/articles のようになります。

ヘルプセンターのsite_idはどこで見つけられますか?

GET /sites を呼び出すと、ヘルプセンターとその id の一覧が表示されます。これは、ダッシュボードのアドレスバーの /s/ の後に続く識別子でもあります。

次は?

関連する記事

このページは役に立ちましたか?

Still need help? Ask us