Gestion des modèles

🚧

Utiliser des thèmes si possible

À moins que vous n'utilisiez déjà les API de modèles pour le branding, il est recommandé d'utiliser l'API de thèmes à la place. Les thèmes emploient une structure de paquetage plus simple et peuvent être appliqués application par application. Consultez les thèmes ici.

Introduction

Dans ce guide, vous apprendrez comment exporter le paquet de modèles de branding, manipuler les modèles, re-empaqueter les fichiers de modèles, et importer le paquet de modèles de branding mis à jour.

L'API REST d'IBM Security Verify doit être utilisée pour exporter et importer le paquet de modèles. Ce guide montre comment utiliser curl pour les appels d'API requis, car il est multiplateforme, mais vous pourriez également utiliser un programme d'API comme Postman, qui fournit une interface graphique pour manipuler les appels d'API.

Prérequis

Vous devrez obtenir un jeton d'accès autorisé à gérer les modèles. La façon la plus simple de procéder est de créer un client API avec le droit Manage Templates puis d'exécuter le flux de type Client Credentials pour obtenir un jeton d'accès.

Vous aurez besoin de l'utilitaire en ligne de commande curl. Il est intégré à la plupart des systèmes Linux et MacOS. Cependant, vous pouvez également télécharger curl ici.

Variables

Dans ce guide, les variables suivantes sont utilisées :

Vous devriez définir ces variables sur la ligne de commande comme ceci :

export tenant_url=tenant.verify.ibm.com
export access_token=iZ5Gfz66HsNYSoJxhVe7N3u6cdBCHFYWgDOCAsNF

Obtenir le paquet de branding

Le paquet de branding est un fichier zip contenant tous les modèles pour votre locataire. Ceci est obtenu en effectuant un simple appel d'API en utilisant soit curl soit l'utilitaire Postman. Effectuez l'appel d'API suivant pour télécharger le paquet de branding. Il est important d'exécuter cette commande chaque fois que vous apportez une modification pour obtenir les modèles les plus à jour.

curl -X GET https://${tenant_url}/v1.0/branding/download \
  -H "Authorization: Bearer ${access_token}" \
  -o branding.zip

Cela téléchargera un fichier appelé branding.zip dans le répertoire courant.

Si vous utilisez Postman, vous pouvez choisir le répertoire et le nom de fichier lorsque vous enregistrez la réponse :

Décompressez le fichier branding.zip téléchargé pour accéder aux pages de modèles individuelles. Un seul répertoire nommé templates est créé lorsque le fichier zip est extrait.

Modèles communs

Le dossier common dans le paquet de branding contient un ensemble de fichiers englobants qui sont inclus dans chaque page d'utilisateur final. Cela inclut un ensemble de clés de texte, de fichiers de logo, de fichiers HTML d'en-tête / pied de page, et un fichier de substitutions CSS communes. En modifiant les fichiers dans le dossier common, vous pouvez appliquer des modifications de style globalement sans avoir besoin d'éditer chaque page individuelle. Cela dit, vous avez toujours cette capacité si un branding fin est nécessaire.

En-tête / pied de page / logo / styles

La structure dans le dossier commun inclut les sous-dossiers suivants qui permettent la substitution de leurs éléments respectifs :

Étiquettes de modèles

À l'intérieur du dossier ./label_translations, il y a des fichiers appelés template-labels.properties. Ces fichiers de propriétés vivent dans les dossiers de codes de langue qu'IBM Security Verify prend en charge. Les fichiers de modèles suivent le format suivant :

$VARIABLE$=Message

Les paires clé / valeur incluses dans chaque fichier ont été traduites pour vous et se présenteront automatiquement dans la locale du navigateur (si configurée, sinon la valeur par défaut est utilisée qui est l'anglais). Remplacez les valeurs de n'importe quelle étiquette et elle sera prise en compte après avoir zippé et posté les fichiers de retour à Verify.

📘

Les nouvelles étiquettes de modèles sont prises en charge

Des attributs nouveaux supplémentaires peuvent être ajoutés aux pages de modèles en créant une nouvelle paire clé / valeur dans le fichier de modèle

Modèles et thèmes

Dans la structure de répertoires du paquet de modèles, vous verrez que dans chaque dossier de contenu il y a un dossier default. Cela correspond au thème par défaut. Si un thème définit des fichiers personnalisés pour le dossier de contenu, vous verrez également un dossier nommé pour l'ID du thème (un UUID aléatoire) à ce niveau.

Remarque : dans le dossier du thème, il y aura un ou plusieurs dossiers de langue et le dossier de langue par défaut a également le nom default. Cela peut être un peu confus mais rappelez-vous que la structure des dossiers est comme ceci :

templates
  <component>
    <asset>
      metadata.json
      <theme>
        <language>
          content

Vous ne pouvez pas créer de nouveaux thèmes en utilisant l'API de modèles mais vous pouvez ajouter/modifier/supprimer des fichiers associés aux thèmes existants en modifiant le paquet de modèles de branding.

Gestion des langues

Verify prend en charge une variété de langues dans la plateforme qui sont pré-traduites. Cependant, d'autres langues sont prises en charge en créant des dossiers supplémentaires dans le dossier du thème avec le nom du dossier correspondant à la locale de langue du navigateur.

Par exemple, actuellement Verify ne prend pas en charge l'arabe comme langue prête à l'emploi, mais une entreprise souhaitant ajouter une traduction arabe du thème par défaut peut effectuer les actions suivantes :

1. Ouvrir le dossier label_translations/default
2. Dupliquer n'importe quel dossier de langue existant
3. Renommer le dossier à la locale de langue désirée
4. Éditer le fichier et mettre à jour le texte des étiquettes

Cela sera hérité par Verify lorsque la locale du navigateur correspond au code de langue dans le modèle.

Publication de nouveaux modèles

Une fois que vous avez apporté les modifications requises aux fichiers dans le dossier de modèles extrait, vous pouvez appliquer les modifications en re-empaquetant et téléchargeant comme suit :

1. Zippez (compressez) le dossier parent templates (l'archive créée doit inclure le dossier templates)
2. Avec le même jeton d'accès que vous avez utilisé avant (ou obtenez-en un nouveau s'il a expiré), effectuez l'appel d'API suivant pour télécharger le fichier zip mis à jour que vous venez de créer :

curl -X POST https://${tenant_url}/v1.0/branding/upload \
-H "Authorization: Bearer ${access_token}" \
-H 'Content-Type: application/x-www-form-urlencoded' \
-F 'file=@"/path/to/file/updated-branding.zip"'

Vous devriez vous attendre à une réponse 201 Created si tout se vérifie. Les modèles seront immédiatement en direct en production. Si vous ne voyez pas votre modèle en direct, alors soit le téléchargement a échoué, soit votre navigateur a mis en cache les anciens modèles. Essayez un navigateur privé sans cache afin de tester avec précision.

Réinitialiser le branding au défaut

Que vous ayez fait une erreur ou que vous vouliez recommencer, il est bon de comprendre comment revenir aux modèles par défaut de Verify. La demande d'API suivante réinitialisera le paquet de modèles de branding.

Réinitialiser le paquet de modèles de branding a pour effet de supprimer tous les thèmes et de réinitialiser le thème par défaut à son état original. Avant d'utiliser cette API, toutes les applications doivent être configurées pour utiliser le thème par défaut. Cette API retournera une erreur si un thème est en cours d'utilisation.

❗️

Cette API supprimera tout le contenu de modèles et de thèmes

Assurez-vous d'avoir une copie locale de tous les fichiers personnalisés que vous pourriez vouloir utiliser à nouveau plus tard.
Assurez-vous également d'avoir exporté tous les thèmes que vous pourriez vouloir restaurer plus tard.

curl --location --request DELETE https://${tenant_url}/v1.0/branding/reset \
--header "Authorization: Bearer ${access_token}"