Activation du contenu adaptatif

Choisissez une méthode d’authentification pour transmettre les données utilisateur à GitBook.

Pour commencer à personnaliser l’expérience de documentation pour vos lecteurs, vous devez activer le contenu adaptatif et décider comment les données des visiteurs sont transmises à GitBook. Cela permet au contenu de votre site de s’adapter dynamiquement en fonction de qui le consulte.

Activer le contenu adaptatif

Avant de pouvoir transmettre des données utilisateur à GitBook, vous devez configurer votre site pour utiliser le contenu adaptatif.

Rendez-vous dans votre paramètres du site, et activez Contenu adaptatif dans les paramètres d’audience de votre site. Une fois activé, vous obtiendrez une « clé de signature du token visiteur » générée, que vous devrez utiliser pour poursuivre la configuration du contenu adaptatif.

Activer le contenu adaptatif

Définissez votre schéma de visiteur

Après avoir activé le contenu adaptatif, vous devrez définir un schéma pour les types de déclarations (claims) que vous vous attendez à ce que GitBook reçoive lorsqu’un utilisateur visite votre site.

Le schéma visiteur doit refléter la manière dont ces déclarations sont structurées lorsqu’elles sont envoyées à GitBook.

Par exemple, si vous pensez qu’un visiteur peut potentiellement être un utilisateur bêta de votre produit, vous définiriez un schéma visiteur similaire à :

{
  "type": "object",
  "properties": {
    "isBetaUser": {
      "type": "boolean",
      "description": "Si le visiteur est un utilisateur Bêta."
    }
  },
  "additionalProperties": false
}

Cela vous aidera également à utiliser l’autocomplétion lors de la configuration de vos déclarations dans l’ éditeur de conditions. Les schémas visiteur ne prennent en charge que les types suivants :

Chaînes

Lire les déclarations transmises en tant que chaînes.

GitBook accepte des chaînes dynamiques, ce qui signifie que vous pouvez transmettre dynamiquement des données de type chaîne — comme le nom d’un utilisateur, des tokens développeur, et plus encore.

Les chaînes peuvent aussi contenir une énumération optionnelle clé, qui vous permet de restreindre les données reçues par GitBook à l’une de ses valeurs prédéfinies.

{
  "type": "object",
  "properties": {
    "language": {
          "type": "string",
          "description": "La langue du visiteur",
          // Optional enum property
          "enum": [
            "en",
            "fr",
            "it"
          ]
  },
  "additionalProperties": false
}

Les chaînes dynamiques (chaînes définies sans clé enum) ne sont acceptées que pour expressions en ligne. Les expressions conditionnelles pour la visibilité des éléments (pages, sections, blocs) ne fonctionnent qu’avec des chaînes définies avec des clés enum.

Booléens

Objets

Définir une déclaration non signée

Les déclarations non signées sont un type spécifique de déclaration qui identifie les déclarations provenant d’éléments susceptibles de ne pas être signés par une application cliente. Il est nécessaire de définir les déclarations dans votre schéma visiteur comme non signé si vous transmettez des déclarations via des paramètres d’URL, des cookies non signés et des feature flags.

Si vous avez l’intention de travailler avec des déclarations non signées, vous devrez déclarer les déclarations que vous attendez dans le schéma sous une propriété « unsigned » en parallèle de vos déclarations signées.

{
  "type": "object",
  "properties": {
    "isBetaUser": {
      "type": "boolean",
      "description": "Si le visiteur est un utilisateur Bêta."
    },
    // Add unsigned claims
    "unsigned": {
      "type": "object",
      "description": "Déclarations non signées du visiteur du site.",
      "properties": {
        "language": {
          "type": "string",
          "description": "La langue du visiteur",
          // Optional enum property
          "enum": [
            "en",
            "fr",
            "it"
          ]
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Transmettre les données du visiteur à GitBook

GitBook propose différentes manières de transmettre les données des visiteurs pour adapter le contenu de votre site. Après avoir défini votre schéma, vous devrez décider comment vous souhaitez transmettre les données des visiteurs à GitBook.

Cookies

Transmettez les données du visiteur dans votre documentation via un cookie public ou signé.

URL

Transmettez les données du visiteur dans votre documentation via des paramètres de requête URL.

Feature flags

Transmettez les données du visiteur dans votre documentation via un fournisseur de feature flags.

Accès authentifié

Transmettez les données du visiteur dans votre documentation via un fournisseur d’authentification.