Cookie

公開 Cookie または署名付き Cookie を通じて訪問者データをドキュメントに渡す

ガイドを確認して、 完全な手順 Cookie を使ったアダプティブコンテンツの設定方法を確認してください。

機能フラグとともにアダプティブコンテンツを使用するには、アプリケーションにコードを追加する必要があります。

この方法が機能するのは、サイトが次の下で配信されている場合のみです カスタムドメイン.

訪問者のブラウザ Cookie を通じて、訪問者データをドキュメントに渡すことができます。以下に各方法の概要を示します。

方法	用途	設定の容易さ	セキュリティ	形式
署名付き Cookie gitbook-visitor-token	API テスト用認証情報、顧客識別	署名とカスタムドメインが必要	✅ プロパティはバックエンドでのみ定義できます	JWT
公開 Cookie gitbook-visitor-public	機能フラグ、ロール	設定が簡単	❌ 訪問者はプロパティを上書きできます	JSON

公開 Cookie

公開 Cookie から GitBook にデータを渡すには、公開 gitbook-visitor-public Cookie を設定して、アプリケーションからデータを送信する必要があります。

以下は簡単な JavaScript の例です:

import Cookies from 'js-cookie';

const cookieData = {
  isLoggedIn: true,
  isBetaUser: false,
};

Cookies.set('gitbook-visitor-public', JSON.stringify(cookieData), {
  secure: true,
  domain: '*.acme.org',
})

公開 Cookie 経由で渡されるデータは、訪問者スキーマ内で次の方法を使って定義する必要があります 署名なしの オブジェクト。

署名付き Cookie

より安全に GitBook にデータを渡すには、データを次の形式で送信する必要があります JSON Web Token を、アプリケーションから次の名前の Cookie に入れて gitbook-visitor-token 自分のドメインに紐付けます。

これを設定するには、アプリケーションのログインフローを次の手順を含むように調整する必要があります:

1

ユーザーがアプリケーションにログインしたときに JWT を生成する

ユーザーが製品にログインするたびに、認証済みユーザー情報の選択した属性を含む JWT を生成します。

2

サイトの訪問者署名キーを使用して JWT に署名する

次に、サイトの 訪問者署名キーを使って JWT に署名してください。これは、Adaptive Content を有効にした後、サイトの audience 設定で確認できます。

3

JWT をワイルドカードのセッション Cookie に保存する

最後に、ユーザー情報を含む署名済み JWT をワイルドカードのセッション Cookie に保存する必要があります 製品ドメインの下に.

たとえば、アプリケーションが次の下で配信されている場合 app.acme.org ドメイン、Cookie は次の下で作成する必要があります .acme.org ワイルドカードドメイン。

以下は簡単な TypeScript の例です:

import * as jose from 'jose';

import { Request, Response } from 'express';

import { getUserInfo } from '../services/user-info-service';
import { getFeatureFlags } from '../services/feature-flags-service';

const GITBOOK_VISITOR_SIGNING_KEY = process.env.GITBOOK_VISITOR_SIGNING_KEY;
const GITBOOK_VISITOR_COOKIE_NAME = 'gitbook-visitor-token';


export async function handleAppLoginRequest(req: Request, res: Response) {
   // ログインリクエストを処理するためのビジネスロジック
   // たとえば、認証情報を確認してユーザーを認証する
   //
   // 例:
   // const loggedInUser = await authenticateUser(req.body.username, req.body.password);

   // ユーザーを認証した後、渡したいユーザー情報を取得します
   // GitBook に渡すために、データベースまたはユーザーサービスから取得します。
   const userInfo = await getUserInfo(loggedInUser.id);
      
   // ユーザー情報を使って JWT ペイロードを作成します
   const gitbookVisitorClaims = {
       firstName: userInfo.firstName,
       lastName: userInfo.lastName,
       isBetaUser: userInfo.isBetaUser
       products: userInfo.products.map((product) => product.name),
       featureFlags: await getFeatureFlags({userId: loggedInUser.id})
   }
   
   // クレームを使って署名済み JWT を生成します
   const gitbookVisitorJWT = await new jose.SignJWT(gitbookVisitorClaims)
     .setProtectedHeader({ alg: 'HS256' })
     .setIssuedAt()
     .setExpirationTime('2h') // 任意の 2 時間の有効期限
     .sign(GITBOOK_VISITOR_SIGNING_KEY);
     
  // エンコードされた JWT を含む `gitbook-visitor-token` Cookie を
  // ログインハンドラーのレスポンスに含めます
  res.cookie(GITBOOK_VISITOR_COOKIE_NAME, gitbookVisitorJWT, {
     httpOnly: true,
     secure: process.env.NODE_ENV === 'production',
     maxAge: 2 * 60 * 60 * 1000, // 任意の 2 時間の有効期限
     domain: '.acme.org' //
  });
  
  // ユーザーをアプリにリダイレクトする処理を含むログインハンドラーの残りのロジック
  res.redirect('/'); // リダイレクトの例
}