developer

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

APIキーを使用してNotiondesk APIで認証します。Notiondesk APIキーを作成し、読み取り、書き込み、同期、または管理者スコープを選択して、ベアラートークンを使用してREST APIリクエストを認証します。いつでもローテーションまたは取り消すことができます。

OAuthを使用してアプリをNotiondeskに接続します。Notiondesk OAuth アプリを構築します。クライアントを登録し、PKCE を使用して OAuth 2.0 認証コードフローを実行し、トークンを更新し、REST API を呼び出します。

ページネーションとバージョン Notiondesk API リクエストpage_sizeとcursorを使用してNotiondesk APIリストをページングし、nd-versionヘッダーでバージョンを固定し、snake_caseフィールド名を使用します。

Notiondesk APIエラー、レート制限、および再試行を処理するNotiondesk API エラーコードとエンベロープ、1 分あたり 120 回の読み取りと 20 回の書き込みのレート制限、Retry-After、および Idempotency-Key を使用した安全な再試行。

Notiondesk API を使用してヘルプセンターをご覧ください。Notiondesk API を使用して、Notiondesk ヘルプセンターの一覧を表示し、ドメイン、言語、設定を読み取り、スケジュールされた Notion 同期ステータスを確認します。

Notiondesk API を使用して、記事、コレクション、変更履歴エントリを読み取ります。Notiondesk ヘルプセンターの記事やコレクションを、同期状態を維持しながら、任意の言語でマークダウン形式で閲覧し、REST API を介して変更履歴エントリを一覧表示します。

Trigger NotionはNotiondesk APIと同期しますAPI を介して Notion のヘルプセンターを同期します。サイト、コレクション、または記事の同期をトリガーし、スケジュールされた同期をオンまたはオフにします。

Notiondesk API を使用してページのリダイレクトを管理します。REST API を介して、ヘルプセンターページのリダイレクトを作成、一覧表示、更新、削除します。移行後に古い URL を一括インポートします。

Notiondesk API を使用して言語と自動翻訳を管理しますREST API を介して、ヘルプセンターの言語を追加または削除したり、デフォルト言語を設定したり、自動 AI 翻訳をオンまたはオフにしたりできます。

Notiondesk API を使用してヘルプセンターの設定を更新しますREST API を介して Notiondesk ヘルプセンターの設定を更新します: SEO インデックス、ページタイトル、llms.txt およびマークダウンのエクスポート、お問い合わせフォーム、および変更履歴。

Notiondesk API を使用してヘルプセンターのブランディングとテーマをカスタマイズしますREST API を介して Notiondesk ヘルプセンターのブランディングを更新します。更新内容は、色、フォント、レイアウト、ヘッダーとフッターのリンク、検索表示、テーマなどです。

Notiondesk API を使用してヘルプセンターの統合を管理します。REST API を介して、Notiondesk ヘルプセンターで Google Analytics、Plausible、Umami、Intercom、Crisp、Help Scout、Google Tag Manager を設定します。

Notiondesk API を使用してヘルプセンターの分析情報を取得します。REST API を介してヘルプセンターの分析データ (訪問者数、記事閲覧数、上位検索語、検索結果なしの検索、読者の反応) をエクスポートします。

Notiondesk API を使用して読者のフィードバックをエクスポートしますREST API を介して Notiondesk 記事のフィードバックをエクスポートします: 読者の反応、フォローアップの回答、メッセージ、添付ファイル、新しい順。

Notiondesk API を使用して、一般的なヘルプセンターのタスクを自動化します。Notiondesk API の例: GitHub Actions から同期、記事をマークダウンとしてバックアップ、Slack にフィードバックを投稿、検索結果がない検索を報告。