Activation du 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 les données utilisateur à GitBook, vous devrez configurer votre site pour utiliser le contenu adaptatif.

Accédez aux paramètres du site, et activez Contenu adaptatif depuis 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 poursuivre la configuration du contenu adaptatif.

Activez 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 de GitBook lorsqu’un utilisateur visite votre site.

Le schéma de visiteur doit refléter la façon dont ces revendications sont structurées lorsqu’elles sont envoyées à GitBook.

Par exemple, si vous pensez qu’un visiteur peut éventuellement être un utilisateur bêta de 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 lorsque vous configurez vos revendications dans le éditeur de conditions. Les schémas de 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 chaîne — comme le nom d’un utilisateur, des jetons de développeur, et bien plus encore.

Les chaînes peuvent également contenir un enum facultatif 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) ne sont acceptées que pour expressions en ligne. Les expressions conditionnelles de visibilité des éléments (pages, sections, blocs) fonctionnent uniquement avec les chaînes définies avec des clés enum.

Booléens

Lire les revendications transmises sous forme de booléens.

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

Objets

Imbriquez des revendications dans un objet pour regrouper des valeurs similaires.

{
  // Revendications de niveau supérieur
  "type": "object",
  "properties": {
    // Revendications imbriquées
    "access": {
      "type": "object",
      "description": "Accès de l’utilisateur à une fonctionnalité du produit",
      "properties": {
        "isAlphaUser": {
          "type": "boolean",
          "description": "Indique si le visiteur est un utilisateur alpha."
        },
        "isBetaUser": {
          "type": "boolean",
          "description": "Indique si le visiteur est un utilisateur bêta."
        },
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Définir une revendication non signée

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

Si vous comptez 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 », à côté 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 des visiteurs à 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 à votre documentation via un cookie public ou signé.

URL

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

Indicateurs de fonctionnalité

Transmettez les données des visiteurs à votre documentation via un fournisseur d’indicateurs de fonctionnalité.

Accès authentifié

Transmettez les données des visiteurs à votre documentation via un fournisseur d’authentification.