Passer au contenu principal

Initialisation de Digital SDK

Note: Ce document décrit les différences lors de l'utilisation d'un Digital SDK généré à l'aide de la commande de l'interface de ligne de commande Jutro.

Pour les Digital SDK générés sans utiliser l'interface de ligne de commande Jutro, reportez-vous à la documentation sur le SDK Digital.

Présentation​

Avant d'utiliser le SDK généré, vous devez l'initialiser. Ce processus d'initialisation configure le SDK avec la configuration requise pour fonctionner correctement.

Il existe deux façons d'initialiser le SDK :

  • Pour les applications Jutro, utilisez la fonction initSdkJutro.
  • Pour les applications autres que Jutro, utilisez la fonction initSdk.

La différence entre ces deux méthodes réside dans le fait que la méthode initSdk nécessite un objet de configuration, tandis que la méthode initSdkJutro rend cet objet facultatif, car les informations sont extraites par défaut des variables d'environnement de Jutro.

Note: Les composants générés pour les extensions d'interface utilisateur du Digital SDK n'ont aucun impact dans les deux scénarios. Ces composants sont créés pendant l'étape de génération et fonctionneront de la même manière, quelle que soit la fonction d'initialisation utilisée.

Vous pouvez importer ces fonctions directement à partir du ou des SDK générés. Si vous avez généré plusieurs SDK, vous devrez initialiser chacun d’entre eux.

Warning: Assurez-vous que le processus d'initialisation est terminé avant de commencer à utiliser le SDK à partir de votre application.

Applications autres que Jutro​

Si vous utilisez la fonction initSDK pour initialiser un Digital SDK, reportez-vous à la documentation sur le SDK Digital.

Applications Jutro​

Si vous utilisez la fonction initSdkJutro pour initialiser un Digital SDK, l'objet de configuration est facultatif et les valeurs par défaut sont extraites de vos variables d'environnement. Dans la plupart des cas, vous serez en mesure d'initialiser le SDK avec une seule ligne de code dans les applications Jutro :

import { initSdkJutro } from 'src/generated/<your-sdk-name>';

initSdkJutro();

Objet de remplacement de la configuration​

La fonction initSdkJutro accepte un objet de configuration facultatif. Vous pouvez utiliser cet objet pour remplacer les informations issues des variables d'environnement, ou au cas où, pour une raison quelconque, ces variables ne sont pas configurées dans votre application Jutro.

L'objet de configuration accepté par la fonction initSdkJutro utilise les mêmes options que la fonction initSdk, mais toutes les propriétés sont facultatives.

type InitSdkParamObjectJutro = {
  auth?: AuthParam;
  backendUrl?: string;
  enableStickySession?: boolean;
  language?: string | null;
};

Valeurs par défaut des paramètres de configuration​

Lorsque vous utilisez la fonction initSdkJutro, les propriétés par défaut des objets de configuration sont les suivantes :

auth​

Le paramètre auth est un objet contenant les informations d'authentification que le SDK généré utilisera pour les requêtes d'API. Pour en savoir plus sur la propriété auth et les options d'authentification disponibles, reportez-vous à la documentation sur le SDK Digital.

Si aucun paramètre auth n'est fourni, le SDK déduit la méthode d'authentification à l'aide des règles et variables d'environnement suivantes :

  • Si les variables d'environnement REACT_APP_BASIC_USERNAME et REACT_APP_BASIC_PASSWORD sont définies, le SDK utilise l'authentification de base.

  • Si la variable d'environnement JUTRO_AUTH_ENABLED est définie sur true, le SDK utilise l'authentification JWT et une fonction getAccessToken est requise comme paramètre. La fonction getAccessToken est fournie par @jutro/auth.

  • Si la variable d'environnement ENABLE_ANONYMOUS_AUTH est définie sur true, le SDK utilise l'authentification anonyme.

  • Si aucune des variables d'environnement ci-dessus n'est définie, le SDK effectue les requêtes d'API comme étant non authentifiées.

backendUrl​

Le paramètre backendUrl est l'URL de l'instance d'application InsuranceSuite que le SDK utilisera comme URL de base pour les requêtes d'API. Il doit s'agir d'une URL d'API d'application InsuranceSuite telle que https://pc-environment-starsystemid-tenant.api.guidewire.net/rest.

Le paramètre par défaut backendUrl sera extrait de vos variables d'environnement Jutro. Par exemple, si vous utilisez PolicyCenter, le SDK utilise par défaut l'backendUrl à partir de la variable d'environnement JUTRO_PC_CLOUD_API_URL.

enableStickySession​

Les sessions persistantes sont une fonctionnalité permettant aux environnements en cluster d'activer l'affinité des sessions dans le service de transport. Pour une explication plus détaillée de cette fonctionnalité, reportez-vous à la documentation sur le SDK Digital.

Lorsque vous utilisez la fonction initSdkJutro, la valeur par défaut de la propriété enableStickySession est la valeur de la variable d'environnement JUTRO_ENABLE_STICKY_SESSION.

Note: Si vous utilisez le Digital SDK dans une application composée d’une application shell et de plusieurs modules micro front-end, il se peut que enableStickySession ne génère pas des valeurs cohérentes pour les en-têtes de session persistants.

Pour en savoir plus, reportez-vous à la documentation sur les modules micro front-end.

language​

La propriété language est utilisée pour initialiser le SDK avec une langue préférée. La propriété est facultative, quelle que soit la version d'initialisation utilisée, et se comporte de manière identique dans les deux scénarios. Pour en savoir plus sur cette propriété, reportez-vous à la documentation sur le SDK Digital.

Exemple de remplacement de configuration​

Dans cet exemple, nous configurons le SDK pour utiliser l'authentification Anonymous au lieu de la méthode d'authentification extraite des variables d'environnement.

import { initSdkJutro, AuthType } from 'src/generated/<your-sdk-name>';

initSdkJutro({
  auth: {
    authType: AuthType.Anonymous,
  },
});

Accès à l'instance Axios​

Pour obtenir des instructions sur l'accès à l'instance Axios directement à partir d'un SDK initialisé, reportez-vous à la documentation sur le SDK Digital.

Utilisation des éditions​

Pour obtenir des instructions sur la configuration ou l'obtention de l'édition pour les lignes métier avec un SDK initialisé, reportez-vous à la documentation sur le SDK Digital.