Publishing

Next.js

Next.jsサンプルを使ってSurpasso記事を表示します。

設定時間の目安:10分

サイトはContent APIで公開記事を読み込みます。既存ブログ管理画面へ記事を保存する場合はWebhookを選びます。

準備

  • サイトのAI開発ツールまたは保守担当者。
  • ホスティング設定を変更する権限。

開発ツールへ説明とサンプルを渡す

既存アプリを置き換えず、現在のデザイン、記事、リンクを保ってSurpasso記事を表示するよう次の指示をコピーします。

接続手順を表示
Surpasso は企業の SEO・GEO 記事の企画、執筆、公開を支援する製品です。既存サイトを Surpasso に接続してください。最初にフレームワーク、ブログのルート、記事の保存方法、デザイン、デプロイ方法を確認し、既存機能を優先して再利用します。サイトを作り直したり、既存記事を削除・上書きしたりしないでください。

Next.js 連携(Content API を使用)を使用します。サイトのサーバー側で Surpasso の公開済み記事を読み取ります。記事は Surpasso で管理され、ローカル CMS へ自動コピーされません。サーバー環境変数:SURPASSO_URL=https://surpasso.ai、SURPASSO_CONTENT_API_KEY=<デプロイ設定で安全に構成>。Authorization: Bearer にサーバー側キーを使用し、NEXT_PUBLIC_ は使わないでください。

実際の API:GET /api/content/v1/articles?limit=50 は {items:[article],nextCursor} を返します。nextCursor があれば cursor パラメーターで次ページを取得します。GET /api/content/v1/articles/{id-or-slug} は {item:article} を返します。updated_since で更新を絞り込めます。読めるのは公開済み記事のみです。空の一覧は接続失敗ではなく、テスト目的で下書きを自動公開しないでください。401、404、429(Retry-After を尊重)、一時エラーを処理します。ETag / If-None-Match と 304 に対応し、304 を JSON として解析しないでください。

フィールド対応:id は安定した記事識別子、revision はコンテンツ版、title は見出し、slug は記事パス、excerpt は要約、contentMarkdown / contentHtml は本文(既存エディターに合う形式を選び、HTML は安全に処理)、metaTitle / metaDescription は SEO メタデータ、featuredImage.url / alt はカバー画像と代替テキスト、images は本文画像、author / authorType / authorUrl は著者、editor / reviewer と各 Type / Url は編集クレジット、categories / tags は分類、language はコンテンツ言語、contentFamilyId / alternates は多言語関係とリンク、structuredData は構造化データ、canonicalUrl は正規 URL です。最終 URL にはサイトの実際の公開パスを使い、誤った canonical をコピーしないでください。null は適切に処理し、未対応の任意フィールドで公開を止めないでください。

記事には日付表示とキャッシュ更新用の publishedAt と updatedAt も含まれます。既存ブログのパスを再利用し、一覧、詳細、安全な本文表示、SEO、canonical、Open Graph、言語リンク、Sitemap を補います。既存記事と URL は保持してください。成功した取得結果をキャッシュし、一時障害では可能な限りキャッシュを表示し、更新反映までの待ち時間を説明します。

Next.js 固有要件:プロジェクトの Next.js バージョンと対応文書を確認してから、既存の App Router / Pages Router に合わせてください。バージョンを決めつけないでください。新規ブログは /blog と /blog/[slug] を使用でき、既存サイトでは現在のルートを維持します。読み取り処理はサーバー専用にし、既存の metadata と sitemap を拡張します。必要な場合だけ保護されたキャッシュ更新エンドポイントを追加し、独立した SURPASSO_REVALIDATE_SECRET と、そのバージョンで対応するキャッシュ API を使ってください。

必要な確認を実行した後、変更した機能、デプロイ手順、設定する環境変数名と設定先、Surpasso に戻して入力する URL、記事の新規公開と更新を確認する方法を、一般ユーザーにも分かる言葉で説明してください。秘密情報はサイトのデプロイ環境の環境変数で設定するよう案内し、チャット、Git、ブラウザーコードには入れさせないでください。

必要ならNext.jsサンプルをダウンロードし、既存サイトへ合わせて調整させます。READMEは単独実行方法を説明しています。

キーと環境変数を設定する

Integrations → Custom → Next.jsでキーを作り、SURPASSO_URL=https://surpasso.aiとSURPASSO_CONTENT_API_KEY=<キー>をホスティングへ保存します。サンプルを使う場合はNEXT_PUBLIC_SITE_URL=https://example.comも設定し、再デプロイします。

記事を確認する

Content Calendarで記事を公開し、サイトの本文、画像、リンクを確認します。接続画面の読取状況を確認でAPI呼出も確認します。編集・再公開後、同じページが更新されることを確認してください。

公開記事だけが表示され、サイト固有のブログ管理画面へは保存されません。サンプルは成功した読取を1時間キャッシュします。変更を早く見せる場合は開発ツールに間隔調整または保護された更新方法を依頼してください。Surpassoがサンプルの更新エンドポイントを自動呼出することはありません。

記事がない、エラー、キー問題

記事公開、正しいキーの環境変数、再デプロイ、サイトURLを確認します。キーを交換した場合はホスティングも更新します。詳細なレスポンス、フィールド、制限はContent APIガイドを参照してください。