[Alpha]{class="badge informative"}

Visão geral do Server SDK for JavaScript

O Adobe Experience Platform Server SDK para JavaScript, ou o Server SDK, é uma biblioteca que é executada no servidor e envia dados para o Adobe Experience Platform Edge Network. Ela é executada no Node.js e em outros tempos de execução do JavaScript do lado do servidor que atendem aos requisitos. Ele foi publicado no npm como @adobe/alloy-node. Este guia aborda os principais conceitos, instalação, configuração e métodos.

O SDK do Servidor compartilha seu núcleo com a Web SDK. Ele usa as mesmas sequências de dados, o mesmo modelo de dados XDM e os mesmos cookies de identidade e consentimento. Como ele é executado em um servidor em vez de em um navegador, difere em como você cria instâncias, autentica e lida com a solicitação de cada visitante.

IMPORTANT
O SDK do servidor está em alfa. Seus métodos, opções e comportamento podem mudar entre as versões, e somente os recursos listados em Recursos com suporte estão disponíveis. Revise as notas de versão antes de atualizar.

Quando usar o SDK do servidor when-to-use

O Adobe oferece várias maneiras de enviar dados para a Edge Network. Escolha aquele que corresponde ao local onde seu código é executado:

Abordagem
Use-o quando
Web SDK
Seu código é executado no navegador do visitante. O Web SDK pode renderizar conteúdo personalizado, coletar cliques em links e ler o contexto da página automaticamente.
SDK do Servidor
Seu código é executado em um servidor do JavaScript que lida com a solicitação do visitante. Por exemplo, um servidor que renderiza páginas, um back-end de API ou middleware que busca personalização antes que a página chegue ao navegador.
API Edge Network
Você deseja chamar a Edge Network diretamente, de qualquer idioma, sem uma biblioteca. O SDK do servidor chama essa API para você.

Você pode usar o Server SDK e a Web SDK juntos. Por exemplo, seu servidor pode solicitar conteúdo personalizado e o navegador pode renderizá-lo. Consulte Personalização híbrida.

Como funciona how-it-works

  1. Quando o servidor for iniciado, você criará uma instância e chamará configure uma vez com sua sequência de dados, organização e credenciais de API.
  2. Para cada solicitação recebida, você chama forRequest para obter um identificador que tenha como escopo esse visitante. O identificador lê e grava a identidade e o consentimento do visitante por meio do serviço de cookie fornecido, e encaminha os cabeçalhos de solicitação do visitante (como User-Agent) para a Edge Network.
  3. Você chama métodos no identificador, como sendEvent. O SDK envia eventos para a API do Edge Network Server autenticada usando um token de acesso que ele obtém e armazena em cache para você.
  4. O SDK retorna os resultados ao seu código. Por exemplo, sendEvent retorna propostas de personalização como dados. O SDK não os renderiza. Seu aplicativo decide o que fazer com eles, como incluí-los na página para que o Web SDK seja renderizado.

Consulte Instâncias e solicitações para obter mais detalhes.

Recursos compatíveis features

A tabela a seguir lista o que a versão alfa suporta. Consulte Diferenças do Web SDK para obter uma comparação detalhada.

Recurso
Status
Enviar eventos com sendEvent
Suportado
Recuperar identidade com getIdentity e appendIdentityToUrl
Suportado
Consentimento com setConsent e defaultConsent
Compatível. defaultConsent aceita somente "in" e "out".
Solicitar personalização com personalization
Compatível. Proposições são retornadas como dados e não são renderizadas.
Dados de contexto
Parcialmente compatível. Consulte Contexto e cabeçalhos encaminhados.
Depurando com debugEnabled e setDebug
Compatível. Os logs são gravados no console.
Renderização de conteúdo personalizado, coleção de cliques, análise de mídia, notificações por push, Brand Concierge, públicos-alvo e cartões de conteúdo baseados em regras
Incompatível

Exigências requirements

Antes de usar o Server SDK, verifique se você tem o seguinte:

  • Um tempo de execução do JavaScript do lado do servidor, como Node.js 22 ou posterior. O tempo de execução deve dar suporte a módulos ECMAScript, pois você carregará o pacote com import. Também deve fornecer os seguintes globais padrão da Web: fetch, Headers, URLSearchParams, crypto.getRandomValues, setTimeout, clearTimeout, atob, btoa, TextEncoder, TextDecoder e console. Consulte Suporte de tempo de execução.
  • Uma sequência de dados. Consulte Configurar uma sequência de dados. Se você usa getIdentity, appendIdentityToUrl ou setConsent, defina o Tipo de Acesso da sequência de dados como Autenticação Mista, pois esses métodos enviam solicitações não autenticadas. Consulte Autenticação.
  • Uma credencial de servidor para servidor OAuth da Adobe Developer Console. O SDK o exige e o usa para autenticar os eventos enviados. Consulte Autenticação.
  • Um esquema XDM e conjunto de dados, se você enviar dados para a Adobe Experience Platform.

Suporte de tempo de execução runtime-support

O Server SDK é compatível com qualquer tempo de execução do JavaScript do lado do servidor que atenda aos requisitos. Isso não depende dos módulos específicos do Node.js. Seus serviços de plataforma padrão usam apenas APIs padrão da Web, como fetch.

Esses guias usam Node.js como o tempo de execução de exemplo principal. Os exemplos de código usam convenções Node.js, como ler credenciais de process.env e lidar com solicitações com o módulo node:http. Se você usar um tempo de execução diferente, substitua essas partes pelos equivalentes do tempo de execução. Os próprios métodos do SDK funcionam da mesma maneira em todos os tempos de execução compatíveis.

Código Source e feedback source

O SDK do servidor é de código aberto. Seu código-fonte está na pasta packages/node do repositório adobe/alloy no GitHub. Relate problemas e solicite recursos nesse repositório.

Próximas etapas next-steps

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