@afiliado/sdk
v1.0.13
Published
SDK oficial para integração com o motor de links do afiliado.me
Downloads
792
Maintainers
Readme
@afiliado/sdk 🚀
SDK oficial do afiliado.me para Node.js e ambientes modernos.
Transforme URLs brutas de marketplaces em ofertas ricas com links de afiliado injetados e assinatura de segurança via HMAC (SHA-256).
📦 Instalação
npm install @afiliado/sdk
# ou
yarn add @afiliado/sdk🛠️ Configuração Rápida
Para utilizar o SDK, você precisará apenas da sua API Key, disponível no Hub de Integrações do painel do afiliado.me. Suas configurações de marketplace (Amazon, Shopee, Mercado Livre) são vinculadas automaticamente à sua chave no nosso back-end.
import { AfiliadoSDK } from '@afiliado/sdk';
// Inicialize o SDK com a sua chave de acesso
const afiliado = new AfiliadoSDK({
apiKey: process.env.AFILIADO_API_KEY!
});📖 Como Usar
🔍 Extrair dados de um produto (Parse)
O método parse:
- Identifica automaticamente o marketplace (Amazon, Shopee, Mercado Livre).
- Extrai título, preço, imagem e descontos diretamente da página.
- Injeta automaticamente a sua tag/ID de afiliado para garantir o seu comissionamento.
- Assina a requisição com HMAC SHA-256 para segurança ponta a ponta.
async function handleOffer(rawUrl: string) {
try {
const product = await afiliado.parse({
url: rawUrl,
// baseUrl: 'https://sua-api-customizada.com' // Opcional
});
console.log(product.title); // Ex: "Apple iPhone 15 Pro Max (256 GB)"
console.log(product.price_discount); // Ex: 7499.00
console.log(product.short_url); // Ex: "https://s.shopee.com.br/1BGzyGBXP9"
} catch (error: any) {
console.error('Erro no SDK:', error.message);
}
}🔒 Segurança (HMAC)
Diferente de SDKs tradicionais, o @afiliado/sdk não trafega sua API Key em texto puro.
Cada requisição feita pelo seu servidor é:
- Assinada digitalmente usando HMAC SHA-256.
- Validada com timestamp de disparo.
- Protegida nativamente contra Replay Attacks.
- Recusada imediatamente caso o payload seja adulterado no meio do caminho.
Isso garante integridade absoluta e segurança das suas credenciais de afiliado.
📊 Estrutura de Retorno (ParsedOffer)
O objeto retornado após o processamento bem-sucedido contém todos os dados prontos para disparo em redes sociais ou WhatsApp:
| Campo | Tipo | Descrição |
|--------------------|--------|-----------|
| id | string | Identificador único interno da oferta gerada |
| title | string | Título limpo e otimizado para leitura |
| price_discount | number | Preço atualizado do produto (com desconto aplicado) |
| price_original | number | Preço original do produto (sem desconto) |
| image_url | string | URL da imagem principal em alta resolução |
| link_original | string | Link longo original (com sua tag embutida) |
| short_url | string | Link encurtado oficial do afiliado.me |
| marketplace | string | Identificador da loja (amazon, shopee ou mercadolivre) |
📊 Objeto aninhado (metadata)
Contém dados auxiliares opcionais e complementares da oferta:
| Campo | Tipo | Descrição |
|--------------------|--------|-----------|
| description | string | (Opcional) Descrição comercial curta do produto |
| percent_discount | string | (Opcional) Percentual numérico do desconto (Ex: 15 para 15%) |
| has_discount | number | (Opcional) Flag indicando se o produto está em promoção |
| cod | number | (Opcional) Código interno (ASIN/SKU/Item ID) do marketplace |
📄 Licença
MIT © afiliado.me
