Activer le contenu adaptatif

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

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

Activer le contenu adaptatif

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

Rendez-vous dans les paramètres de votre site, et activez Contenu adaptatif dans les paramètres d’audience de votre site. Une fois activé, vous obtiendrez une « Visitor token signing key » générée, dont vous aurez besoin pour continuer la configuration du contenu adaptatif.

Activez le contenu adaptatif dans les paramètres de votre site

Définissez le schéma de vos visiteurs

Après avoir activé le contenu adaptatif, vous devrez définir un schéma pour les types de revendications que vous attendez de GitBook lorsqu’un utilisateur visite votre site.

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

Par exemple, si vous vous attendez à ce qu’un visiteur puisse être un utilisateur bêta dans votre produit, vous définiriez un schéma de visiteur semblable à :

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

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

Chaînes

Lire les revendications transmises sous forme de chaînes.

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

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

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

Les chaînes dynamiques (chaînes définies sans clé enum) sont acceptées uniquement pour les expressions en ligne. Les expressions conditionnelles de 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 revendication non signée

Les revendications non signées sont un type spécifique de revendication qui identifie les revendications entrantes qui peuvent ne pas être signées par une application cliente. Il est obligatoire de définir les revendications dans le schéma de votre visiteur comme non signées si vous transmettez des revendications via des paramètres d’URL, des cookies non signés et des indicateurs de fonctionnalité.

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

{
  "type": "object",
  "properties": {
    "isBetaUser": {
      "type": "boolean",
      "description": "Indique si le visiteur est un utilisateur bêta."
    },
    // Ajouter des revendications non signées
    "unsigned": {
      "type": "object",
      "description": "Revendications non signées du visiteur du site.",
      "properties": {
        "language": {
          "type": "string",
          "description": "La langue du visiteur",
          // Propriété enum facultative
          "enum": [
            "en",
            "fr",
            "it"
          ]
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Transmettre les données du visiteur à GitBook

GitBook propose différentes façons de transmettre les données des visiteurs afin d’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 de vos 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 d’URL.

Indicateurs de fonctionnalité

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

Accès authentifié

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