[Alpha]{class="badge informative"}

Información general sobre Server SDK para JavaScript

Adobe Experience Platform Server SDK for JavaScript, o Server SDK, es una biblioteca que se ejecuta en el servidor y envía datos a Adobe Experience Platform Edge Network. Se ejecuta en Node.js y en otros tiempos de ejecución de JavaScript del lado del servidor que cumplen con sus requisitos. Se publica en npm como @adobe/alloy-node. Esta guía cubre los conceptos básicos, la instalación, la configuración y los métodos.

El servidor SDK comparte su núcleo con Web SDK. Utiliza las mismas secuencias de datos, el mismo modelo de datos XDM y las mismas cookies de identidad y consentimiento. Dado que se ejecuta en un servidor en lugar de en un explorador, difiere en la forma en que se crean instancias, se autentican y se gestiona la solicitud de cada visitante.

IMPORTANT
El SDK del servidor está en alfa. Sus métodos, opciones y comportamiento pueden cambiar de una versión a otra y solo están disponibles las características que se enumeran en Características compatibles. Revise las notas de la versión antes de actualizar.

Cuándo utilizar el SDK de servidor when-to-use

Adobe ofrece varias formas de enviar datos a Edge Network. Elija el que coincida con el lugar donde se ejecuta el código:

Enfoque
Úselo cuando
Web SDK
El código se ejecuta en el explorador del visitante. Web SDK puede procesar contenido personalizado, recopilar clics en vínculos y leer automáticamente el contexto de la página.
Servidor SDK
El código se ejecuta en un servidor de JavaScript que administra la solicitud del visitante. Por ejemplo, un servidor que procesa páginas, un back-end de API o un middleware que obtiene personalización antes de que la página llegue al explorador.
API de Edge Network
Desea llamar a Edge Network directamente, desde cualquier idioma, sin una biblioteca. El SDK del servidor llama a esta API por usted.

Puede utilizar Server SDK y Web SDK juntos. Por ejemplo, el servidor puede solicitar contenido personalizado y el explorador puede procesarlo. Consulte Personalización híbrida.

Funcionamiento how-it-works

  1. Cuando se inicia el servidor, crea una instancia y llama a configure una vez con la secuencia de datos, la organización y las credenciales de la API.
  2. Para cada solicitud entrante, llama a forRequest para obtener un identificador con ámbito para ese visitante. El controlador lee y escribe la identidad y el consentimiento del visitante a través del servicio de cookies que proporciona y reenvía los encabezados de solicitud del visitante (como User-Agent) a Edge Network.
  3. Llama a métodos en el identificador, como sendEvent. SDK envía eventos a la API de Edge Network Server autenticada mediante un token de acceso que obtiene y almacena en caché por usted.
  4. SDK devuelve los resultados a su código. Por ejemplo, sendEvent devuelve propuestas de personalización como datos. SDK no los procesa. La aplicación decide qué hacer con ellos, como incluirlos en la página para que Web SDK los procese.

Consulte Instancias y solicitudes para obtener más información.

Funciones compatibles features

La siguiente tabla enumera lo que admite la versión alfa. Vea Diferencias de Web SDK para obtener una comparación detallada.

Función
Estado
Enviar eventos con sendEvent
Admitido
Recuperar identidad con getIdentity y appendIdentityToUrl
Admitido
Consentimiento con setConsent y defaultConsent
Compatible. defaultConsent solo acepta "in" y "out".
Solicitar personalización con personalization
Compatible. Las propuestas se devuelven como datos y no se procesan.
Datos de contexto
Admitido parcialmente. Ver Contexto y encabezados reenviados.
Depurando con debugEnabled y setDebug
Compatible. Los registros se escriben en la consola.
Procesamiento de contenido personalizado, recopilación de clics, análisis de medios, notificaciones push, Brand Concierge, audiencias y tarjetas de contenido basado en reglas
No compatible

Requisitos requirements

Antes de usar Server SDK, asegúrese de que dispone de lo siguiente:

  • Tiempo de ejecución de JavaScript del lado del servidor, como Node.js 22 o posterior. El motor en tiempo de ejecución debe admitir módulos ECMAScript, ya que se carga el paquete con import. También debe proporcionar los siguientes valores globales estándar de la web: fetch, Headers, URLSearchParams, crypto.getRandomValues, setTimeout, clearTimeout, atob, btoa, TextEncoder, TextDecoder y console. Consulte Compatibilidad en tiempo de ejecución.
  • Flujo de datos. Consulte Configurar una secuencia de datos. Si usa getIdentity, appendIdentityToUrl o setConsent, establezca Tipo de acceso de la secuencia de datos en Autenticación mixta, ya que estos métodos envían solicitudes no autenticadas. Ver Autenticación.
  • Credencial de servidor a servidor OAuth de Adobe Developer Console. SDK lo requiere y lo utiliza para autenticar los eventos que envía. Ver Autenticación.
  • Un esquema XDM y un conjunto de datos, si envía datos a Adobe Experience Platform.

Compatibilidad con Runtime runtime-support

Server SDK es compatible con cualquier tiempo de ejecución de JavaScript del lado del servidor que cumpla los requisitos. No depende de módulos específicos de Node.js. Sus servicios de plataforma predeterminados solo usan API web estándar, como fetch.

Estas guías utilizan Node.js como el ejemplo de tiempo de ejecución principal. Los ejemplos de código utilizan convenciones de Node.js, como la lectura de credenciales de process.env y la administración de solicitudes con el módulo node:http. Si utiliza un tiempo de ejecución diferente, reemplace estas partes por los equivalentes del tiempo de ejecución. Los métodos propios de SDK funcionan de la misma manera en todos los tiempos de ejecución admitidos.

Código Source y comentarios source

Server SDK es de código abierto. Su código fuente se encuentra en la carpeta packages/node del repositorio adobe/alloy en GitHub. Notificar problemas y solicitar funciones en ese repositorio.

Próximos pasos next-steps

recommendation-more-help
experience-platform-help-collection