Cómo usar Cookies con IronPDF en C#

¿Qué es la propiedad RequestContext?

Establezca la propiedad RequestContext en RequestContexts.Global antes de aplicar las cookies. Crea la clase ChromeHttpLoginCredentials y pásala al método ApplyCookies. A continuación, el renderizador pasa el contenido HTML a PDF con cookies.

La propiedad RequestContext funciona con cabeceras de solicitud HTTP y autenticación. Determina el uso compartido de cookies entre sesiones de renderizado, algo fundamental para que las aplicaciones mantengan el estado de la sesión en varias generaciones de PDF.

¿Cómo se utiliza el método ApplyCookies?

Solicite cookies mediante IronPDF:

:path=/static-assets/pdf/content-code-examples/how-to/cookies-apply-cookies.cs

using IronPdf;

// Instantiate ChromePdfRenderer
ChromePdfRenderer renderer = new ChromePdfRenderer();

renderer.RenderingOptions.RequestContext = IronPdf.Rendering.RequestContexts.Global;

ChromeHttpLoginCredentials credentials = new ChromeHttpLoginCredentials() {
    NetworkUsername = "testUser",
    NetworkPassword = "testPassword"
};

string uri = "http://localhost:51169/Invoice";

// Apply cookies
renderer.ApplyCookies(uri, credentials);

Este enfoque funciona al convertir páginas ASPX a PDF que requieren autenticación o con aplicaciones ASP.NET MVC.

¿Qué RequestContext debo elegir?

RequestContexts Enum define los contextos de solicitud del navegador que establecen las relaciones entre los renders. Gestiona las cookies y las preferencias del usuario.

• Aislado: Crea nuevos contextos de solicitud aislados. Evita que los renders actuales se vean afectados por renders anteriores. Ideal para generación de PDF multihilo.
• Global: Utiliza un contexto de solicitud global compartido entre todos los renders. Persiste los estados del navegador entre renders. Perfecto para mantener los datos de sesión a través de operaciones PDF.
• Auto: El valor predeterminado es IronPDF.Rendering.RequestContexts.Isolated. Cambia a IronPdf.Rendering.RequestContexts.Global si se ha invocado IronPdf.ChromePdfRenderer.ApplyCookies(System.String, IronPdf.ChromeHttpLoginCredentials).

Al implementar cookies en aplicaciones de Blazor Server, elija el RequestContext apropiado para mantener el estado de sesión adecuado entre las renderizaciones del lado del servidor.

¿Qué son las cookies personalizadas en IronPDF?

Las cookies personalizadas requieren la configuración de la propiedad CustomCookies. Esta propiedad acepta diccionarios de pares clave-valor de cadena. Las cookies personalizadas gestionan sistemas de autenticación complejos o pasan datos a nivel de aplicación durante la renderización.

Las cookies personalizadas se diferencian de las cookies HTTP estándar en que permiten cualquier definición de par clave-valor. Esta flexibilidad se adapta a las aplicaciones web modernas que utilizan tokens JWT, identificadores de sesión o mecanismos de autenticación personalizados.

¿Cómo implementar cookies personalizadas?

Aplique cookies personalizadas mediante IronPDF:

:path=/static-assets/pdf/content-code-examples/how-to/cookies-apply-custom-cookies.cs

using IronPdf;
using System;
using System.Collections.Generic;

// Instantiate ChromePdfRenderer
ChromePdfRenderer renderer = new ChromePdfRenderer();

Dictionary<string, string> customCookies = new Dictionary<string, string>();

// Apply custom cookies
renderer.RenderingOptions.CustomCookies = customCookies;

var uri = new Uri("https://localhost:44362/invoice");
PdfDocument pdf = renderer.RenderUrlAsPdf(uri);

Este enfoque es adecuado para sitios con mucho JavaScript que dependen de las cookies para la gestión del estado o que implementan soluciones de registro personalizadas.

¿Cuándo debo usar cookies personalizadas frente a cookies estándar?

Las cookies personalizadas gestionan datos de sesión específicos o tokens de autenticación no gestionados por las credenciales HTTP estándar. Utilícelas con sistemas de autenticación personalizados o para mantener las preferencias del usuario durante la generación de PDF.

Se utilizan cookies estándar (mediante el método ApplyCookies):

• Autenticación HTTP básica
• Entornos de autenticación de Windows
• Gestión sencilla de sesiones

Las cookies personalizadas sobresalen por:

• Autenticación basada en token JWT
• Gestión de sesiones complejas con múltiples parámetros
• Proveedores de autenticación de terceros (OAuth, SAML)
• Mantenimiento de preferencias y ajustes del usuario
• Requisitos de análisis y seguimiento

¿Cuáles son los problemas comunes con la implementación de cookies?

Entre los problemas más comunes se incluyen que las cookies no persistan entre renderizaciones utilizando el contexto Isolated, fallos de autenticación por valores de cookies incorrectos y problemas de sincronización en los que las cookies caducan antes de la generación del PDF. Verifique la validez de las cookies y tenga en cuenta el contexto Global para las sesiones persistentes.

Consejos para la resolución de problemas:

1. Caducidad de cookies: Verifica que las cookies no hayan caducado. Implementar la lógica de actualización para tokens de corta duración.
2. Restricciones de dominio: asegúrese de que los dominios de las cookies coincidan con la URL traducida.
3. Cookies seguras: Configurar correctamente las cookies seguras al renderizar URLs HTTPS.
4. Políticas SameSite: Tenga en cuenta las políticas de cookies SameSite del navegador que afectan a las solicitudes de origen cruzado.

Para la autenticación avanzada y los escenarios de cookies, consulte la documentación de opciones de renderización que cubre todos los ajustes de personalización de generación de PDF disponibles.