[Alpha]{class="badge informative"}

Présentation de Server SDK for JavaScript

Adobe Experience Platform Server SDK for JavaScript ou Server SDK est une bibliothèque qui s’exécute sur votre serveur et envoie des données à Adobe Experience Platform Edge Network. Il s’exécute dans Node.js et dans d’autres exécutions JavaScript côté serveur qui répondent à ses exigences. Il est publié sur npm en tant que @adobe/alloy-node. Ce guide couvre ses concepts de base, l’installation, la configuration et les méthodes.

Server SDK partage son cœur avec Web SDK. Il utilise les mêmes flux de données, le même modèle de données XDM et les mêmes cookies d’identité et de consentement. Étant donné qu’il s’exécute sur un serveur plutôt que dans un navigateur, il diffère dans la manière dont vous créez des instances, vous authentifiez et gérez la requête de chaque visiteur.

IMPORTANT
Le SDK du serveur est en version Alpha. Ses méthodes, options et comportements peuvent changer d’une version à l’autre et seules les fonctionnalités répertoriées dans Fonctionnalités prises en charge sont disponibles. Consultez les notes de mise à jour avant de procéder à la mise à niveau.

Quand utiliser le SDK du serveur when-to-use

Adobe propose plusieurs manières d’envoyer des données à Edge Network. Sélectionnez celui qui correspond à l’emplacement d’exécution de votre code :

Approche
Utilisez-le lorsque
Web SDK
Votre code s’exécute dans le navigateur du visiteur. Web SDK peut automatiquement générer du contenu personnalisé, collecter les clics sur les liens et lire le contexte de la page.
Server SDK
Votre code s’exécute sur un serveur JavaScript qui gère la requête du visiteur. Par exemple, un serveur qui effectue le rendu des pages, un serveur principal d’API ou un middleware qui récupère la personnalisation avant que la page n’atteigne le navigateur.
API ​
Vous souhaitez appeler l’Edge Network directement, depuis n’importe quelle langue, sans bibliothèque. Le SDK du serveur appelle cette API pour vous.

Vous pouvez utiliser à la fois le SDK du serveur et le SDK Web. Par exemple, votre serveur peut demander du contenu personnalisé et le navigateur peut en effectuer le rendu. Voir Personnalisation hybride.

Fonctionnement how-it-works

  1. Au démarrage de votre serveur vous créez une instance et appelez-la une configure fois avec vos informations d’identification de flux de données, d’organisation et d’API 🔗.
  2. Pour chaque requête entrante vous appelez forRequest pour obtenir un objet Handle qui est défini sur ce visiteur. Le handle lit et écrit l’identité et le consentement du visiteur par le biais du service de cookies que vous fournissez et transfère les en-têtes de requête du visiteur (tels que User-Agent) à Edge Network.
  3. Vous appelez des méthodes sur le handle telles que sendEvent. Le SDK envoie des événements à l’API du serveur Edge Network authentifiée à l’aide d’un jeton d’accès qu’il obtient et met en cache pour vous.
  4. Le SDK renvoie les résultats à votre code. Par exemple, sendEvent renvoie des propositions de personnalisation sous forme de données. Le SDK ne les effectue pas. Votre application décide de ce qu’elle doit faire, par exemple les inclure dans la page pour que le SDK Web s’affiche.

Voir ​ Instances et requêtes ​ pour plus d’informations.

Fonctionnalités prises en charge features

Le tableau suivant répertorie les fonctionnalités prises en charge par la version Alpha. Voir Différences par rapport à Web SDK pour une comparaison détaillée.

Fonctionnalité
Statut
Envoyer des événements avec sendEvent
Pris en charge
Récupérer l’identité avec getIdentity et appendIdentityToUrl
Pris en charge
Consentement avec setConsent et defaultConsent
Pris en charge. defaultConsent accepte uniquement les "in" et les "out".
Demander la personnalisation avec personalization
Pris en charge. Les propositions sont renvoyées sous forme de données et ne sont pas rendues.
Données contextuelles
Partiellement pris en charge. Voir En-têtes contextuels et transférés.
Débogage avec debugEnabled et setDebug
Pris en charge. Les journaux sont écrits dans la console.
Rendu de contenu personnalisé, collection de clics, media analytics, notifications push, Brand Concierge, audiences et cartes de contenu basées sur des règles
Non pris en charge

Conditions requises requirements

Avant d’utiliser le SDK du serveur, vérifiez que vous disposez des éléments suivants :

  • Exécution JavaScript côté serveur, par exemple Node.js 22 ou version ultérieure. Le runtime doit prendre en charge les modules ECMAScript, car vous chargez le package avec import. Il doit également fournir les paramètres globaux standard web suivants : fetch, Headers, URLSearchParams, crypto.getRandomValues, setTimeout, clearTimeout, atob, btoa, TextEncoder, TextDecoder et console. Voir Prise en charge d’Runtime.
  • Un flux de données. Voir Configurer un flux de données. Si vous utilisez getIdentity, appendIdentityToUrl ou setConsent, définissez le Type d’accès du flux de données sur Authentification mixte, car ces méthodes envoient des requêtes non authentifiées. Voir Authentification.
  • Informations d’identification de serveur à serveur OAuth à partir de Adobe Developer Console. Le SDK l’exige et l’utilise pour authentifier les événements qu’il envoie. Voir Authentification.
  • Schéma XDM et jeu de données, si vous envoyez des données à Adobe Experience Platform.

Prise en charge de l’exécution runtime-support

Server SDK est pris en charge dans tout environnement d’exécution JavaScript côté serveur qui répond aux exigences. Cela ne dépend pas des modules spécifiques à Node.js. Ses services de plateforme par défaut utilisent uniquement des API web standard, telles que fetch.

Ces guides utilisent Node.js comme exemple principal d’exécution. Les exemples de code utilisent les conventions Node.js, telles que la lecture des informations d’identification des process.env et la gestion des requêtes avec le module node:http. Si vous utilisez un runtime différent, remplacez ces parties par les équivalents de votre runtime. Les propres méthodes de SDK fonctionnent de la même manière dans chaque exécution prise en charge.

Code Source et commentaires source

Le SDK du serveur est en open source. Son code source se trouve dans le dossier packages/node du référentiel adobe/alloy sur GitHub. Signalez les problèmes et demandez des fonctionnalités dans ce référentiel.

Étapes suivantes next-steps

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