Confluence API ページ取得：設定と出力の確認
執筆：Ai Flowi · 公開日
公式情報源：Confluence Cloud REST API ドキュメント
Confluence API ページ取得の連携では、サイト URL、ユーザー名、API キー、スペースキーで設定する ウィキ ソースのコンポーネントを使います。閲覧を許可されたスペースの内容を調べ、後続の文書ワークフローに利用してください。AI Flowi Workflow のエクスポートされた Confluence インターフェースには JSON 出力があり、ページ書き込み操作の記載はありません。
カタログの説明は Confluence ウィキ コラボレーションプラットフォーム
です。以下の設定によるスペースの読み取りは、設定例。
1. 許可されたソース範囲を選ぶ
目的のソースへのアクセス権を持つ、自身の Confluence アカウントと API 認証情報が必要です。サイトのアドレス、導入形態、閲覧を許可されたスペースを特定してください。認証情報を非公開に保ち、最初の確認には合成の ウィキ コンテンツを使います。
スペースキーは要求するソースを選ぶもので、すべてのページを読む権限を作るものではありません。要求に使うアカウントを確認し、返却内容をそのアカウントで見えるページと比較します。後続のコピーは別の閲覧者に届く可能性があるため、非公開の ウィキ テキストを他のサービスへ移す前に、保存先を確認してください。
このソースの仕様は、他のサービスと併せてコンポーネントを掲載するコンポーネントカタログを補足します。製品全体で既に記載されている認証情報の仕組みは、接続を参照してください。ウィキ の API キーを Google OAuth 接続として扱わないでください。
2. エクスポートされた 7 つの入力を埋める
6 つのフィールドが必須です。任意なのは max_pages だけで、任意という指定からデフォルトのページ数は分かりません。省略するとスペース全体を読むと証明されるわけでもありません。
カタログに基づく設定例。Ai Flowi による本番検証は未実施です。
| フィールド | 型／必須 | 接続型／選択肢 | 決める内容 |
|---|---|---|---|
api_key | str／はい | 接続の一覧は空です | 非公開のフィールドに自身のソース認証情報を設定します。認証情報の発行手順はここでは示していません。 |
cloud | bool／はい | 接続は未指定です | 導入環境に合う真偽値を選びます。実行時の解釈はエクスポートされていませんが、必須です。 |
content_format | str／はい | 接続は未指定です；選択肢：”body.editor”, “body.export_view”, “body.anonymous_export_view”, “body.storage”, “body.view” | 一覧の本文形式から 1 つを選び、保存先向けに整形する前に実際の表現を確認します。 |
max_pages | int／いいえ | 接続は未指定です | 取得範囲を調べる間は、意図して小さい整数を使います。デフォルト値、最大値、ページネーションの仕様は記載されていません。 |
space_key | str／はい | 接続は未指定です | 自身の wiki で確認したソーススペースの識別子を入力します。表示タイトルと一致する場合を除き、タイトルは使いません。 |
url | str／はい | 接続は未指定です | 目的の Confluence サイトのアドレスを使い、エディターでエンドポイントの要件を確認します。 |
username | str／はい | 接続は未指定です | 導入環境と認証方式が求める、権限を持つアカウントの識別子を入力します。 |
3. 確認する本文表現を決める
content_format の選択肢は "body.editor"、"body.export_view"、"body.anonymous_export_view"、"body.storage"、"body.view" です。これらはカタログの値そのものです。ラベルだけでは、プレーンテキスト出力、移植可能な文書形式、ページマクロの維持は確認できません。
合成データの検証では "body.view" を選び、返却テキストを表示された ウィキ ページと比較します。保存先がプレーンテキストを必要とする場合、変換を選ぶ前にマークアップが含まれるか確認してください。「export」を含む値だけで、添付ファイル、コメント、履歴を含む完全なエクスポートと想定しないでください。
"body.anonymous_export_view" を選んでも、必須のユーザー名と API キーのフィールドが不要になるわけではありません。カタログでは、選んだ形式にかかわらず両入力が必須です。選択肢の名前から認証動作を推測せず、アクセスを明示的にテストしてください。
4. 範囲を絞ってソースを検証する
- タイトルと本文を確認できる内容を持つ、小規模な許可済みテストスペースを作成または選択します。自身のアカウントがアクセスできると想定するページを記録してください。
- Confluence を追加します。自身のソース設定で
url、username、api_key、space_keyを設定します。その環境に合うcloudを選んでください。 - この確認では、
content_formatを"body.view"、max_pagesを上限の例として2に設定します。選んだ件数は記録された出力ではなく、完全性を示すものでもありません。 - JSON 出力の
dataを調べます。実際のページ本文、識別子、存在するソース参照を特定してください。エクスポートには結果キーのスキーマがないため、名前を作り出さず検証します。 - 返却ページを想定するテスト対象と比較します。アカウントがページを読めない場合と、選んだページ上限に達した場合に何が起こるか確認してください。
- 構造を確認してから、JSON を受け入れる受信コンポーネントを設定します。後続の変換を確認できるよう、最初のソース結果を保持してください。
5. 出力を完成文書ではなくソースとして扱う
出力の表示名は JSON、ポートは data、宣言されている型は JSON です。このコンポーネントには、Table、Message、個別のエラーポートはエクスポートされていません。この違いが、直接受け取れる後続ノードを決めます。
テキストテンプレートのインターフェースはParser リファレンス、確認済みのスナップショット用に ウィキ ページを選ぶ方法はConfluence から Google Docs への転送ガイドを参照してください。
Confluence連携のWiki取得範囲の制約は何ですか？
このカテゴリには、ページ作成、編集、コメント、イベントトリガーの操作がありません。エクスポートされた入力には、ページ ID 選択、添付ファイルの切り替え、増分カーソル、版履歴の制御もありません。スペースとページ上限を指定しても、完全で安定したスナップショットの証拠にはなりません。
すべての関係、添付ファイル、改訂を維持すべきアーカイブ用エクスポートには、この例を使わないでください。ソースの権限を確認できない場合や、後続のテキストの閲覧者を管理できない場合も避けます。再実行とプロバイダーエラーは自身の環境で確認が必要です。ここでは、組み合わせたフローの成功を主張していません。
目的がベクトル検索なら、Pinecone の仕様を別途確認します。そのインデックス、名前空間、埋め込みの設定には、ウィキ のアクセス規則が自動的に引き継がれるわけではありません。ソースの読み取りと検索には、それぞれ適切なアクセス境界が必要です。
使用量と設定
実際の実行と後続ノードを数え、プロバイダーの制限を個別に確認してください。連携一覧は、このサービス固有の設定の親リファレンスです。