@myago/sdk
v0.1.2
Published
Myago Dev-First SDK
Downloads
40
Readme
@myago/sdk 🔌
O SDK oficial do Myago para desenvolvedores.
Integre infraestrutura de email marketing, envios transacionais e failover multi-provedor em sua aplicação com apenas algumas linhas de código.
🚀 Instalação
npm install @myago/sdk
# ou
yarn add @myago/sdk🛠️ Como usar
Inicialização
import { MyagoClient } from '@myago/sdk';
const client = new MyagoClient({
apiKey: 'mya_live_...', // Sua chave de API
baseUrl: 'https://api.myago.com.br' // Opcional
});Enviar Email Transacional
Perfeito para confirmações de cadastro, recuperação de senha ou notificações PIX/Boleto com idempotência garantida.
await client.emails.send({
to: '[email protected]',
subject: 'Seu pedido foi confirmado!',
html: '<h1>Obrigado por comprar conosco!</h1>',
idempotencyKey: 'order_12345' // Evita envios duplicados
});Gerenciar Contatos
// Criar ou atualizar (upsert)
await client.contacts.create({
nome: 'João Silva',
email: '[email protected]',
tags: ['lead', 'pro-plan']
});
// Listar contatos
const { data } = await client.contacts.list({
limit: 50,
tags: ['lead']
});Templates e Campanhas
// Criar um template via HTML
const template = await client.templates.create({
nome: 'Boas-vindas Verão',
conteudoHtml: '<html>...</html>'
});
// Disparar uma campanha existente
await client.campaigns.send('id_da_campanha', {
all: true // ou tags: ['newsletter']
});📈 Métricas
Acompanhe a saúde da sua operação programaticamente.
const metrics = await client.metrics.getDashboard();
console.log(`Taxa de abertura média: ${metrics.openRate}%`);🔒 Segurança e Boas Práticas
- Nunca exponha sua
apiKeyno frontend da sua aplicação. - Use variáveis de ambiente (
process.env.MYAGO_API_KEY). - Utilize a
idempotencyKeyem transações críticas para evitar envios duplicados em caso de retentativas de rede.
📄 Licença
MIT © Myago