1.0.0 • Published 7 months ago

kitty-affiliate-sdk v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
7 months ago

// README.md

Kitty Affiliate SDK

SDK JavaScript para integração com o sistema de afiliados Kitty.

Instalação

npm install kitty-affiliate-sdk
# ou
yarn add kitty-affiliate-sdk

Uso

// ES Modules
import KittyAffiliateSDK from 'kitty-affiliate-sdk';

// CommonJS
const KittyAffiliateSDK = require('kitty-affiliate-sdk');

// Inicializar SDK
KittyAffiliateSDK.init('sua-api-key');

// Gerar um lead
const leadResult = await KittyAffiliateSDK.generateLead({
  fingerprint_id: 'hash123',
  lead_id: 'user123',
  lead_email: 'usuario@exemplo.com',
  timezone: 'America/Sao_Paulo',
  aff_id: 'aff123'
});

// Adicionar uma conversão
const conversionResult = await KittyAffiliateSDK.addConversion({
  external_id: 'conv123',
  lead_id: 'user123',
  trial: true,
  amount: 99.90,
  currency: 'BRL',
  product_name: 'Premium Plan',
  product_group: 'Subscription',
  metadata: {
    source: 'website'
  }
});

Métodos Disponíveis

init(apiKey)

Inicializa o SDK com sua chave de API.

generateLead(params)

Gera um novo lead.

addConversion(params)

Adiciona uma nova conversão.

Licença

MIT

1.0.0

7 months ago