Saltar al contenido principal

Inicialización del SDK de Digital

Note: En este documento, se abordan las diferencias de cuando se utiliza el SDK de Digital generado mediante el comando de Jutro CLI.

Para los SDK de Digital generados sin usar Jutro CLI, consulte la documentación del SDK de Digital.

Descripción general​

Antes de usar el SDK generado, debe inicializarlo. Este proceso de inicialización dará al SDK la configuración necesaria para que funcione correctamente.

Hay dos maneras de inicializar el SDK:

  • Para aplicaciones de Jutro, utilice la función initSdkJutro.
  • Para aplicaciones que no sean de Jutro, utilice la función initSdk.

La diferencia entre estos dos métodos es que initSdk requerirá un objeto de configuración, mientras que, cuando se utilice initSdkJutro, dicho objeto será opcional, ya que la información se tomará de las variables de entorno de Jutro por defecto.

Note: Los componentes generados para las extensiones de la interfaz de usuario del SDK de Digital no se ven afectados en ninguno de los casos. Estos componentes se crean durante el paso de generación y funcionarán de la misma manera, independientemente de la función de inicialización que se utilice.

Puede importar estas funciones directamente desde los SDK generados. En caso de que haya generado varios SDK, deberá inicializar cada uno de ellos.

Warning: Asegúrese de completar el proceso de inicialización antes de empezar a utilizar el SDK desde la aplicación.

Aplicaciones que no son de Jutro​

Si utiliza la función initSDK para inicializar un SDK de Digital, consulte la documentación del SDK de Digital.

Aplicaciones de Jutro​

Si se utiliza la función initSdkJutro para inicializar un SDK de Digital, el objeto de configuración es opcional y los valores predeterminados se tomarán de las variables de entorno. En la mayoría de los casos, podrá inicializar el SDK con una sola línea de código en las aplicaciones de Jutro:

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

initSdkJutro();

Objeto de invalidación de configuración​

La función initSdkJutro acepta un objeto de configuración opcional. Puede usar este objeto para invalidar la información obtenida de las variables de entorno o en caso de que estas variables no estén configuradas en su aplicación de Jutro por algún motivo.

El objeto de configuración aceptado por la función initSdkJutro utiliza las mismas opciones que la función initSdk , pero todas las propiedades son opcionales.

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

Valores predeterminados del parámetro de configuración​

Cuando se utiliza la función initSdkJutro, las propiedades predeterminadas de los objetos de configuración son las siguientes:

auth​

El parámetro auth es un objeto que contiene la información de autenticación que el SDK generado utilizará para las solicitudes de la API. Para obtener más información sobre la propiedad auth y las opciones de autenticación disponibles, consulte la documentación del SDK de Digital.

Si no se proporciona ningún parámetro auth, el SDK inferirá el método de autenticación mediante las siguientes reglas y variables de entorno:

  • Si se establecen las dos variables de entorno REACT_APP_BASIC_USERNAME y REACT_APP_BASIC_PASSWORD, el SDK usará la autenticación básica.

  • Si la variable de entorno JUTRO_AUTH_ENABLED se establece en true, el SDK utilizará la autenticación JWT y se requerirá una función getAccessToken como parámetro. La función getAccessToken es proporcionada por @jutro/auth.

  • Si la variable de entorno ENABLE_ANONYMOUS_AUTH se establece en true, el SDK utilizará la autenticación anónima.

  • Si no se establece ninguna de las variables de entorno anteriores, el SDK realizará las solicitudes de API como no autenticadas.

backendUrl​

El parámetro backendUrl es la URL de la instancia de la aplicación de InsuranceSuite que el SDK utilizará como URL base para las solicitudes de la API. Debe ser una URL de la API de la aplicación de InsuranceSuite como https://pc-environment-starsystemid-tenant.api.guidewire.net/rest.

El parámetro backendUrl predeterminado se tomará de las variables de entorno de Jutro. Por ejemplo, si utiliza PolicyCenter, de forma predeterminada el SDK tomará backendUrl de la variable de entorno JUTRO_PC_CLOUD_API_URL.

enableStickySession​

Las sesiones persistentes son una característica para entornos agrupados que permiten la afinidad de sesión en el servicio de transporte. Para obtener una explicación más detallada de esta característica, consulte la documentación del SDK de Digital.

Cuando se utiliza la función initSdkJutro, el valor predeterminado de la propiedad enableStickySession será el valor de la variable de entorno JUTRO_ENABLE_STICKY_SESSION.

Note: Si utiliza el SDK de Digital en una aplicación que consta de una aplicación shell y varios microfrontends, es posible que enableStickySession no dé lugar a valores coherentes para los encabezados de sesión persistentes.

Para obtener más información, consulte la documentación sobre microfrontend.

language​

La propiedad language se utiliza para inicializar el SDK con un idioma preferido. La propiedad es opcional, independientemente de la versión de inicialización que se utilice, y se comporta de manera idéntica en ambos escenarios. Para obtener más información sobre esta propiedad, consulte la documentación del SDK de Digital.

Ejemplo de invalidación de configuración​

En este ejemplo, configuraremos el SDK para usar la autenticación Anonymous, en lugar del método de autenticación tomado de las variables de entorno.

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

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

Acceso a la instancia de Axios​

Para obtener instrucciones sobre cómo acceder a la instancia de Axios directamente desde un SDK inicializado, consulte la documentación del SDK de Digital.

Trabajar con ediciones​

Para obtener instrucciones sobre cómo configurar u obtener la edición para líneas de negocio con un SDK inicializado, consulte la documentación del SDK de Digital.