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 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 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.

Allez 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 jeton visiteur » générée, dont vous aurez besoin pour poursuivre la configuration du contenu adaptatif.

Activer le contenu adaptatif dans les Paramètres de votre site

Définir votre schéma de visiteur

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

Le schéma visiteur doit refléter la façon 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 de votre produit, vous définiriez un schéma visiteur similaire à :

{
  "type": "object",
  "properties": {
    "isBetaUser": {
      "type": "boolean",
      "description": "Si le visiteur est un utilisateur Beta."
    }
  },
  "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 visiteur ne prennent en charge que 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 type chaîne — comme le nom d'un utilisateur, des jetons développeur, et plus encore.

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

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

Les chaînes dynamiques (chaînes définies sans une clé enum) ne sont acceptées que pour les 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 revendication non signée

Les revendications non signées sont un type spécifique de revendication qui identifie les revendications pouvant provenir de sources qui ne sont pas signées par une application cliente. Il est nécessaire de définir des revendications dans votre schéma visiteur comme non signé si vous transmettez des revendications via des paramètres d'URL, des cookies non signés et des feature flags.

Si vous avez l'intention de travailler avec des revendications non signées, vous devrez déclarer les revendications que vous attendez dans le schéma sous une propriété « unsigned » aux côtés de vos revendications signées.

{
  "type": "object",
  "properties": {
    "isBetaUser": {
      "type": "boolean",
      "description": "Si le visiteur est un utilisateur Beta."
    },
    // 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 optionnelle
          "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 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 de vos visiteurs à GitBook.

Cookies

Transmettez les données des visiteurs dans votre documentation via un cookie public ou signé.

URL

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

Feature flags

Transmettez les données des visiteurs dans votre documentation via un fournisseur de feature flags.

Accès authentifié

Transmettez les données des visiteurs dans votre documentation via un fournisseur d'authentification.