Konektor Mailgun
Połącz Mailgun z Brevo przez Tajo, aby ujednolicić dane e-maili transakcyjnych i marketingowych, synchronizować zdarzenia dostarczania i metryki zaangażowania oraz konsolidować infrastrukturę e-mailową w jeden widok klienta.
Przegląd
| Właściwość | Wartość |
|---|---|
| Platforma | Mailgun (by Sinch) |
| Kategoria | E-mail Marketing |
| Poziom konfiguracji | Łatwy |
| Integracja oficjalna | Nie |
| Synchronizowane dane | Zdarzenia, Kontakty, Dostarczalność, Kampanie |
| Metoda uwierzytelniania | Klucz API (HTTP Basic Auth) |
Funkcje
- Synchronizacja zdarzeń dostarczenia - Śledź zdarzenia dostarczone, odrzucone, otwarte i kliknięte
- Metryki zaangażowania - Synchronizuj wskaźniki otwarć i kliknięć z atrybutami kontaktów Brevo
- Zarządzanie odrzuceniami - Automatycznie wyciszaj odrzucone adresy w Brevo
- Obsługa skarg - Synchronizuj skargi na spam dla higieny listy
- Reputacja domeny - Monitoruj kondycję domeny wysyłającej i dostarczalność
- Śledzenie e-maili transakcyjnych - Koreluj wysyłki transakcyjne z danymi marketingowymi
Wymagania wstępne
Zanim zaczniesz, upewnij się, że masz:
- Konto Mailgun ze zweryfikowaną domeną wysyłającą
- Klucz API Mailgun z Mailgun Dashboard
- Konto Brevo z dostępem do API
- Konto Tajo z uprawnieniami konektora
Uwierzytelnianie
Uwierzytelnianie kluczem API
Mailgun używa HTTP Basic Authentication z api jako nazwą użytkownika i kluczem API jako hasłem:
# Get your API key from https://app.mailgun.com/settings/api_securityexport MAILGUN_API_KEY=key-your-api-keyexport MAILGUN_DOMAIN=your-domain.comexport TAJO_API_KEY=your_tajo_api_keyexport BREVO_API_KEY=your_brevo_api_key// HTTP Basic Auth formatconst headers = { 'Authorization': `Basic ${Buffer.from( `api:${process.env.MAILGUN_API_KEY}` ).toString('base64')}`};
// Or using curl// curl -s --user 'api:YOUR_API_KEY' ...Typy kluczy API
Mailgun dostarcza klucze wysyłania specyficzne dla domeny i klucze API na poziomie konta. Używaj kluczy wysyłania domeny dla operacji wiadomości i klucza API konta dla operacji zarządzania.
Konfiguracja
Podstawowa konfiguracja
connectors: mailgun: enabled: true api_key: "${MAILGUN_API_KEY}" domain: "${MAILGUN_DOMAIN}" region: "us" # or "eu" for EU region
sync: events: true contacts: true bounces: true complaints: true schedule: "*/15 * * * *" # Every 15 minutes
webhook: signing_key: "${MAILGUN_WEBHOOK_SIGNING_KEY}"
lists: engaged: 30 bounced: 31 complained: 32Mapowanie pól
field_mapping: email: email first_name: FIRSTNAME last_name: LASTNAME open_rate: MG_OPEN_RATE click_rate: MG_CLICK_RATE last_delivered: MG_LAST_DELIVERED bounce_type: MG_BOUNCE_TYPE engagement_score: MG_ENGAGEMENT unsubscribed: MG_UNSUBSCRIBEDEndpointy API
| Endpoint | Metoda | Opis |
|---|---|---|
https://api.mailgun.net/v3/{domain}/messages | POST | Wyślij wiadomości e-mail |
https://api.mailgun.net/v3/{domain}/events | GET | Zapytaj logi zdarzeń |
https://api.mailgun.net/v3/{domain}/bounces | GET | Lista odrzuceń |
https://api.mailgun.net/v3/{domain}/complaints | GET | Lista skarg |
https://api.mailgun.net/v3/{domain}/unsubscribes | GET | Lista rezygnacji |
https://api.mailgun.net/v3/{domain}/tags | GET | Lista tagów |
https://api.mailgun.net/v3/{domain}/tags/{tag}/stats | GET | Statystyki tagów |
https://api.mailgun.net/v3/lists | GET | Lista list mailingowych |
https://api.mailgun.net/v3/domains | GET | Lista domen |
https://api.mailgun.net/v4/address/validate | POST | Walidacja adresu e-mail |
Region UE
Dla kont Mailgun w UE używaj https://api.eu.mailgun.net zamiast https://api.mailgun.net dla wszystkich endpointów API.
Przykłady kodu
Inicjalizacja konektora
import { TajoClient } from '@tajo/sdk';
const tajo = new TajoClient({ apiKey: process.env.TAJO_API_KEY, brevoApiKey: process.env.BREVO_API_KEY});
await tajo.connectors.connect('mailgun', { apiKey: process.env.MAILGUN_API_KEY, domain: process.env.MAILGUN_DOMAIN, region: 'us'});Wyślij wiadomość przez Mailgun API
// Send an email using Mailgun's Messages APIconst formData = new URLSearchParams();formData.append('from', `Your App <noreply@${domain}>`);formData.append('subject', 'Welcome to our platform');formData.append('html', '<h1>Welcome!</h1><p>Thanks for signing up.</p>');formData.append('o:tag', 'welcome-email');formData.append('o:tracking', 'yes');
const response = await fetch( `https://api.mailgun.net/v3/${domain}/messages`, { method: 'POST', headers: { 'Authorization': `Basic ${Buffer.from(`api:${apiKey}`).toString('base64')}` }, body: formData });
const result = await response.json();// { id: '<[email protected]>', message: 'Queued. Thank you.' }Synchronizuj zdarzenia e-mail z Brevo
// Query Mailgun events and sync engagement dataconst eventsResponse = await fetch( `https://api.mailgun.net/v3/${domain}/events?` + new URLSearchParams({ begin: lastSyncDate, ascending: 'yes', limit: 300, event: 'delivered OR opened OR clicked' }), { headers: { 'Authorization': `Basic ${Buffer.from(`api:${apiKey}`).toString('base64')}` } });
const { items, paging } = await eventsResponse.json();
for (const event of items) { const email = event.recipient;
switch (event.event) { case 'delivered': await tajo.contacts.update(email, { attributes: { MG_LAST_DELIVERED: event.timestamp } }); break; case 'opened': await tajo.events.track({ email, event: 'email_opened', properties: { subject: event.message.headers.subject } }); break; case 'clicked': await tajo.events.track({ email, event: 'email_clicked', properties: { url: event.url } }); break; }}
// Follow pagination for more eventsif (paging.next) { // Fetch next page using paging.next URL}Obsługa webhooków Mailgun
const crypto = require('crypto');
app.post('/webhooks/mailgun', async (req, res) => { // Verify webhook signature const { timestamp, token, signature } = req.body.signature; const encodedToken = crypto .createHmac('sha256', process.env.MAILGUN_WEBHOOK_SIGNING_KEY) .update(timestamp.concat(token)) .digest('hex');
if (encodedToken !== signature) { return res.status(401).send('Unauthorized'); }
const eventData = req.body['event-data']; const event = eventData.event; const email = eventData.recipient;
await tajo.connectors.handleWebhook('mailgun', { topic: event, payload: eventData });
// Handle bounce suppression if (event === 'failed' && eventData.severity === 'permanent') { await tajo.contacts.update(email, { attributes: { MG_BOUNCE_TYPE: 'hard_bounce' }, emailBlacklisted: true }); }
res.status(200).send('OK');});Synchronizuj odrzucenia i skargi
// Sync bounced addresses for list hygieneconst bouncesResponse = await fetch( `https://api.mailgun.net/v3/${domain}/bounces?limit=100`, { headers: { 'Authorization': `Basic ${Buffer.from(`api:${apiKey}`).toString('base64')}` } });
const { items: bounces } = await bouncesResponse.json();
for (const bounce of bounces) { await tajo.contacts.update(bounce.address, { attributes: { MG_BOUNCE_TYPE: bounce.error.includes('550') ? 'hard_bounce' : 'soft_bounce', MG_BOUNCE_DATE: bounce.created_at }, emailBlacklisted: bounce.error.includes('550') });}Limity API
| Endpoint | Limit | Uwagi |
|---|---|---|
| Messages API | Zależy od planu | 100/godz (free), nieograniczony (płatny) |
| Events API | Brak wyraźnego limitu | Używaj paginacji z maks. 300 elementami |
| Validation API | Zależy od planu | Płatność za walidację |
| Webhooki | Czas rzeczywisty | Brak limitu dla dostarczania |
| Suppressions API | Brak wyraźnego limitu | Standardowe ograniczanie stosuje się |
Limity wysyłania
Mailgun egzekwuje limity wysyłania oparte na Twoim planie i reputacji domeny. Nowe domeny zaczynają z niższymi limitami, które rosną w miarę poprawy reputacji nadawcy. Monitoruj statystyki domeny w dashboardzie Mailgun.
Rozwiązywanie problemów
| Problem | Przyczyna | Rozwiązanie |
|---|---|---|
| 401 Unauthorized | Nieprawidłowy klucz API | Zweryfikuj klucz API w dashboardzie Mailgun |
| Domena niezweryfikowana | Brakujące rekordy DNS | Dodaj wymagane rekordy TXT, CNAME, MX |
| Webhook nie odebrany | URL niedostępny | Upewnij się, że URL webhooka jest publicznie dostępny |
| Brakujące zdarzenia | Zbyt wąski zakres czasu | Rozszerz parametry begin/end |
| Niska dostarczalność | Reputacja domeny | Sprawdź statystyki domeny i uwierzytelnianie |
Tryb debug
connectors: mailgun: debug: true log_level: verbose log_webhooks: true log_events: trueNajlepsze praktyki
- Weryfikuj domeny wysyłające - Ukończ weryfikację DNS dla optymalnej dostarczalności
- Używaj webhooków dla zdarzeń - Dostarczanie webhooków w czasie rzeczywistym vs. odpytywanie Events API
- Proaktywnie obsługuj odrzucenia - Natychmiast wyciszaj twarde odrzucenia w Brevo
- Taguj swoje wiadomości - Używaj tagów do kategoryzacji i analizowania wydajności e-maili
- Monitoruj reputację domeny - Śledź metryki dostarczalności w dashboardzie Mailgun
- Używaj walidacji e-maili - Waliduj adresy przed dodaniem do list Brevo
Bezpieczeństwo
- HTTP Basic Auth - Klucz API przekazywany przez nagłówek Authorization
- Podpisy webhooków - Weryfikacja podpisu HMAC-SHA256
- Weryfikacja domeny - Uwierzytelnianie DNS SPF, DKIM i DMARC
- Allowlisting IP - Dostępne dla planów z dedykowanym IP
- Szyfrowanie TLS - Wszystkie endpointy API wymagają HTTPS
- Rotacja kluczy - Regularnie rotuj klucze API przez dashboard Mailgun