SDK

Identificação do usuário

Passe dados do usuário pro SDK melhorar o matching dos seus anúncios.

Identificação de usuários

Chame Paywallo.identify() depois que o usuário fizer login ou preencher o perfil, e antes de mostrar qualquer paywall. Os dados são usados para melhorar a correspondência de atribuição nas plataformas de anúncio, especialmente no Facebook CAPI e TikTok Events API.

tsx
import Paywallo from "@virex-tech/paywallo-sdk";

// Chama depois do login ou cadastro
async function onLoginSuccess(user: User) {
  await Paywallo.identify({
    email: user.email,
    phone: user.phone,
    firstName: user.firstName,
    lastName: user.lastName,
    dateOfBirth: user.dateOfBirth, // "YYYY-MM-DD"
    gender: user.gender,           // "m" | "f"
  });
}

Campos disponíveis:

emailEmail do usuário
phoneTelefone com DDI (ex: +5511999999999)
firstNamePrimeiro nome
lastNameSobrenome
dateOfBirthData de nascimento no formato YYYY-MM-DD (ex: "1990-01-15")
gender"m" para masculino, "f" para feminino
propertiesAtributos customizados do usuário (ex: userId, nome, status da assinatura)

Todos os campos são opcionais, mas quanto mais você enviar, melhor a qualidade do matching (EMQ) no Facebook e TikTok — envie tudo o que tiver disponível, especialmente email, data de nascimento e telefone. Antes de serem enviados para as plataformas de anúncio, os dados de identificação são anonimizados via hash SHA-256.

Atributos customizados (properties)

O campo properties aceita atributos livres do tipo Record<string, string | number | boolean | null>. Use para passar contexto do usuário que seja útil nos seus segmentos e filtros.

tsx
await Paywallo.identify({
  email: user.email,
  properties: {
    userId: user.id,                        // identificador do seu usuário
    name: user.name,
    subscriptionStatus: user.status,        // "active" | "trial" | "expired"
    country: user.country,
    language: user.language,
  },
});

properties.userId é o identificador do seu usuário no seu sistema. Ele é usado no campo recipients ao disparar notificações push — garantindo que a mensagem chegue ao usuário certo independente do dispositivo. Consulte a página de Notificações para ver como usar.

Reset (Logout)

Chame Paywallo.reset() quando o usuário fizer logout. Isso limpa os dados de identificação associados à sessão atual.

tsx
import Paywallo from "@virex-tech/paywallo-sdk";

async function handleLogout() {
  await Paywallo.reset();
  // navega pra tela de login
}

Essa página foi útil?

Desenvolvido e mantido por Virex