Gələnlər qutusu yoxlamasına qoşul
Açıq API ilə pulsuz başlayın və ya SDK-nı endirin. Hesab və API açarı tələb olunmur.
Pulsuz API — daxil olmadan başlayın
Göndərici ünvanınız sınaq üçün texniki məlumatdır. Qeydiyyat və ya təsdiqləmə addımı deyil. you@example.com yerinə məktub göndərəcəyiniz ünvanı yazın.
JavaScript / Python SDK-dan istifadə edin · Brauzerdə işə sal
1. Pulsuz sınaq yaradın
curl -X POST https://check.live-direct-marketing.online/api/tests -H "Content-Type: application/json" -d '{"email":"you@example.com","senderLinkReports":false,"placementChangeAlertsEnabled":false,"finalReportEnabled":false}'Cavabda token, send_to, results_url və expires_at var. Terminalı bağlamazdan əvvəl bunları saxlayın. Nümunələr xatırlatma və hesabat məktublarını söndürür və giriş məktubu istəmir.
2. Öz məktubunuzu göndərin
Yoxlamaq istədiyiniz məktubu həmin ünvandan adi poçt xidmətinizlə send_to siyahısındakı BÜTÜN ünvanlara göndərin. Sınağın yaradılması məktubu avtomatik göndərmir.
3. Nəticəni oxuyun
curl https://check.live-direct-marketing.online/api/tests/YOUR_TEST_TOKEN
YOUR_TEST_TOKEN yerinə 1-ci addımdakı tokeni yazın və ya results_url ünvanını açın. Gözləyərkən bir neçə saniyədən bir sorğunu təkrarlayın. results, summary və authentication sahələrinə baxın. Təkcə yekun vəziyyət Gələnlər qutusuna çatdırılmanı sübut etmir. Tokeninizi məxfi saxlayın. Hesabatı oxumaq üçün hesab tələb olunmur.
400: sorğunu düzəldin. 429: resetAt / Retry-After ilə göstərilən vaxtadək gözləyin. Sınaq yaradılarkən şəbəkə xətası baş verərsə, nəticə naməlumdur. POST sorğusunu avtomatik təkrarlamayın. Nəticəni sorğulamaq üçün tokeni saxlayın. Ümumi gözləmə vaxtı bitdikdə, token və son görüntü qaytarılır ki, daxil olmadan davam edə biləsiniz.
Qonaq SDK-sı: JavaScript və Python
Dəstəklənən müştərini birbaşa endirin. Node.js 18+ və ya Python 3.9+ tələb olunur. Paket meneceri, asılılıqlar və ya API açarı lazım deyil.
JavaScript SDK (.mjs) · Python SDK (.py)
JavaScript
curl -fsS https://check.live-direct-marketing.online/sdk/inbox-check.mjs -o inbox-check.mjs
// Save as check.mjs, replace the sender address, then run: node check.mjs
import { InboxCheck } from './inbox-check.mjs';
const client = new InboxCheck();
const test = await client.createTest({ email: 'you@example.com' });
console.log(test); // Keep token, send_to and results_url.
// Send your own email to ALL send_to addresses before waiting.
// Save the returned token; use the separate read script below.Python
curl -fsS https://check.live-direct-marketing.online/sdk/inbox_check.py -o inbox_check.py
# Save as check.py, replace the sender address, then run: python3 check.py
from inbox_check import InboxCheck
client = InboxCheck()
test = client.create_test('you@example.com')
print(test) # Keep token, send_to and results_url.
# Send your own email to ALL send_to addresses before waiting.
# Save the returned token; use the separate read script below.Saxlanmış tokenlə davam edin və yeni sınaq yaratmayın
Məktubu göndərdikdən sonra EYNİ tokenlə ayrıca skript işlədin. Yaratma skriptini yenidən işlətsəniz, başqa sınaq ünvanları ilə yeni sınaq yaranacaq.
// Save as read.mjs, replace YOUR_TEST_TOKEN, then: node read.mjs
import { InboxCheck } from './inbox-check.mjs';
const client = new InboxCheck();
const report = await client.waitForResult('YOUR_TEST_TOKEN');
console.log(report);# Save as read.py, replace YOUR_TEST_TOKEN, then: python3 read.py
from inbox_check import InboxCheck
client = InboxCheck()
report = client.wait_for_result('YOUR_TEST_TOKEN')
print(report)waitForResult / wait_for_result ilk ölçülmüş poçt xidməti görüntüsünü və ya yekun nəticəni qaytarır. Nəticə qismən ola bilər. status və results sahələrini yoxlayın. Tam yekun hesabat lazım olduqda status done və ya expired olana qədər eyni tokenlə getTest / get_test çağırmağa davam edin. Vaxt bitsə, həmin tokenlə davam etmək olar.
Bu müştərilər açıq /api/tests interfeysindən istifadə edir. Uzaq MCP qonaq alətləri də açarsız işləyir. MCP təlimatından istifadə edin. Bütün cari quraşdırma variantları /sdk/integration.json faylında göstərilib.
Qeydiyyatsız webhook-lar: yerli SDK ötürücüsü
Süni intellekt köməkçiniz bu ötürücünü endirib öz Node.js mühitinizdə sazlayır. Ötürücü SAXLANMIŞ sınaq tokenini oxuyur, yekun done/expired görüntüsünü gözləyir və sonra qəbuledicinizə imzalı bir check.completed hadisəsi göndərir. Prosesi işlək saxlayın. Bu, xidmətin özündə yerləşdirilən webhook abunəliyi deyil.
Webhook ötürücüsünü və imza yoxlayıcısını endircurl -fsS https://check.live-direct-marketing.online/sdk/inbox-check.mjs -o inbox-check.mjs curl -fsS https://check.live-direct-marketing.online/sdk/inbox-check-webhooks.mjs -o inbox-check-webhooks.mjs
SAVED_TEST_TOKEN və YOUR_RECEIVER yerinə artıq yaradılmış tokeni və öz HTTPS qəbuledicinizi yazın. Konfiqurasiya əməliyyatı təsadüfi məxfi imza açarı ilə yeni məxfi fayl yaradır və mövcud faylın üzərinə yazmır.
node inbox-check-webhooks.mjs configure --token SAVED_TEST_TOKEN --url https://YOUR_RECEIVER/hook --config ./inbox-check-webhook.json node inbox-check-webhooks.mjs run --config ./inbox-check-webhook.json
İşə salmazdan əvvəl qəbuledicinizi eyni məxfi açarla sazlayın. Sorğunun xam məzmununu, X-Inbox-Check-Timestamp və X-Inbox-Check-Signature başlıqlarını yoxlayın. İmza sha256=HMAC-SHA256(secret, timestamp + "." + rawBody) şəklindədir. Köhnə zaman nişanlarını rədd edin və event.id üzrə təkrarları çıxarın.
import { verifyWebhook } from './inbox-check-webhooks.mjs';
// Receiver: use your privately configured shared secret and RAW request body.
const valid = verifyWebhook({
body: rawBody, secret: privateSharedSecret,
timestamp: request.headers['x-inbox-check-timestamp'],
signature: request.headers['x-inbox-check-signature']
});
// Reject invalid signatures before parsing/acting on the event.
// Deduplicate JSON.parse(rawBody).id before processing a valid event.Ötürücü heç vaxt sınaq yaratmır və ya sınaq məktubu göndərmir. O, callback POST sorğularını təkrarlamır və yönləndirmələri izləmir. Callback çatdırılması qeyri-müəyyəndirsə, xəta eventId-ni ehtiva edir. Yenidən işə salmazdan əvvəl qəbuledicinizi yoxlayın. Sorğulama vaxtı bitərsə, tokeni və konfiqurasiyanı saxlayın və həmin sınağı davam etdirin. Heç bir məktub alınmadan vaxtı bitmiş nəticə elə həmin vəziyyətdə qalır.
İstəyə bağlı hesab, daha yüksək limitlər və idarə olunan inteqrasiyalar
Qoşulma açarınız
E-poçt keçidi ilə daxil olun. İlk təsdiqlənmiş giriş Hesab bölməsində hesabınızı və açarınızı avtomatik yaradır.
Basic: ilkin olaraq gündə 100 və ayda 1 000 yoxlama, ekran görüntüləri daxil deyil. Hesab bölməsi və me_get dəqiq limitləri və istifadə göstəricilərini göstərir. Hesab bölməsində 500/5 000 yoxlamalı pulsuz paket üçün müraciət edin. Paket təsdiqdən sonra qüvvəyə minir.
Yeni açarları daxil olduqdan sonra yenidən göstərmək və kopyalamaq mümkündür. Köhnə açarlar işləyir, amma onların dəyərini bərpa etmək olmur. Yeni açar yaradın, inteqrasiyanı yeniləyin, sonra köhnə açarı ləğv edin. Açarınızı məxfi saxlayın.
1. Bağlantını yoxlayın
YOUR_API_KEY yerinə açarınızı yazın. GET /api/v1/me bu açarın limitlərini və qalan yoxlamaları göstərir. Bu sorğu yoxlama limitindən istifadə etmir.
curl https://check.live-direct-marketing.online/api/v1/me \ -H "Authorization: Bearer YOUR_API_KEY"
2. Sınaq yaradın
Uğurla yaradılan bir sınaq bir yoxlama limitindən istifadə edir. Açarınız üçün əlçatan xidmətləri GET /api/v1/providers vasitəsilə seçin.
curl -X POST https://check.live-direct-marketing.online/api/v1/tests \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"providers":["gmail","outlook"],"recipient_email":"you@example.com"}'3. Öz məktubunuzu göndərin
Cavabda send_to ünvanları və results_url var. Məktubunuzu öz göndəriş xidmətinizdən qaytarılmış BÜTÜN ünvanlara göndərin. Sınaq yaratmaq məktubu avtomatik göndərmir.
4. Hesabatı açın
results_url ünvanını açın və ya GET /api/v1/tests/:token ilə oxuyun. Nəticələri oxumaq yoxlama limitindən istifadə etmir. Çatdırılma vaxtları dəyişir və məktubun tapılmaması uğurlu çatdırılmanın sübutu deyil.
Limitlər və tarixçə
Basic planı gündə 100, ayda 1 000 yoxlama ilə başlayır. Dəqiq limitlər fərqli ola bilər. Cari açar üçün /api/v1/me, bütün açarlarınız üçün isə Hesab bölməsinə baxın. Əlçatan yoxlama sayı gündəlik və aylıq qalıqdan daha kiçik olanıdır.
Dövrlər hər gün və ayın birinci günü 00:00 UTC-də yenilənir. Hesabda yenilənmə vaxtı yerli saat qurşağında göstərilir. API sorğuları və uğursuz sorğular yoxlamalardan ayrı hesablanır.
Hesab tarixçəsində sorğu təfərrüatları 30 gün saxlanılır. Filtrlər və 20 və ya 50 sətirlik səhifələr mövcuddur. Əhatə göstərilən tarixdə başlayır və əvvəlki qeydlər natamam ola bilər. Sorğuların məzmunu, kukilər və məxfi məlumatlar daxil edilmir.
Daha böyük pulsuz paket üçün müraciət et
Hesab bölməsində «Pulsuz paket üçün müraciət et» seçin. Təsdiqdən sonra seçilmiş açarın limiti gündə 500, ayda 5 000 olacaq. Bu, limitləri əvəz edir. Əlavə yoxlama vermir və istifadə göstəricilərini sıfırlamır. Təsdiqədək mövcud limitlər qüvvədə qalır. Qərar e-poçtla göndərilir.
İstifadəçiyə bağlı account:read icazəli açar öz sorğularını GET /api/v1/account/promo-requests vasitəsilə oxuya bilər. Oxuma icazəsi sorğu yaratmağa və ya təsdiqləməyə imkan vermir. Paket üçün müraciət etmək məqsədilə hesabınıza daxil olun.
Sorğu uğursuz olarsa
Yalnız idarə olunan API üçün: 401 olduqda Bearer açarını, 403 olduqda onun icazələrini yoxlayın. quota_exceeded üçün hər iki limiti yoxlayın. 429/Retry-After göstəricilərinə əməl edin. Server xətası olarsa, yaratma POST sorğusunu təkrarlamazdan əvvəl nəticəni yoxlayın. Dəstəyə müraciət etmək üçün requestId-ni saxlayın və açarınızı heç vaxt göndərməyin.
Tam API istinadı və inteqrasiyalar
Yeni standart açarlar inzibatçı girişi vermədən öz izləməniz üçün məhdudlaşdırılmış icazələrə malikdir. Mövcud açarların icazələri olduğu kimi qalır. Hesab parametrlərində məhdud açar seçimi də var.
Ətraflı istinad: son nöqtələr, planlar və kod
OpenAPI marşrutları və mövcud sorğu sxemlərini sadalayır. Bəzi cavab sxemləri göstərilməyib, nümunələrdən və faktiki cavab sahələrindən istifadə edin. İdarə olunan sorğular Authorization: Bearer YOUR_API_KEY başlığından istifadə edir. İzləməni dəyişmək üçün monitoring:write, oxumaq üçün isə monitoring:read və istifadəçiyə bağlı açar lazımdır.
- GET /api/v1/me
- Açarın metadatası, funksiyalar, icazəli xidmətlər, limit və UTC ilə yenilənmə vaxtları.
- GET /api/v1/providers
- Bu açar üçün əlçatan poçt xidmətləri.
- POST /api/v1/tests
- Sınaq yaradın. 202 cavabında token, send_to və results_url var.
- GET /api/v1/tests
- Sınaqlarınızı cursor və limit parametrləri ilə səhifələnmiş siyahıda alın.
- GET /api/v1/tests/:token
- Qovluq nəticələrini, autentifikasiyanı, diaqnostikanı və mövcud ekran görüntüsü URL-lərini oxuyun.
- DELETE /api/v1/tests/:token
- Sınağı, nəticələri və ekran görüntülərini həmişəlik silin.
- GET /api/v1/monitoring/domains
- Veb-sayt və Telegram ilə ortaq olan izlədiyiniz domenlərin siyahısını alın.
- POST /api/v1/monitoring/domains
- Domeninizi əlavə edin: {"domain":"example.com"}.
- POST /api/v1/monitoring/domains/:id/pause
- Domen izləməsini dayandırın.
- POST /api/v1/monitoring/domains/:id/resume
- Domen izləməsini davam etdirin.
- DELETE /api/v1/monitoring/domains/:id
- İzlədiyiniz domeni silin.
- GET /api/v1/account/promo-requests
- Öz pulsuz paket müraciətlərinizi account:read ilə oxuyun.
Standart planlar
Operatorlar fərdi açarların limitlərini dəyişə bilər. Faktiki limitlər üçün həmişə API-nin qaytardığı dəyərlərdən istifadə edin.
| Plan | Gündə | Ayda | Ekran görüntüləri |
|---|---|---|---|
| basic | 100 | 1,000 | — |
| pro | 500 | 10,000 | Daxildir |
| enterprise | 5,000 | 100,000 | Daxildir |
Node / Python
Ayrıca SDK tələb olunmur. Açarı məxfi mühit dəyişənində saxlayın və mənbə kodu repozitoriyasına daxil etməyin.
Node (fetch)
const response = await fetch('https://check.live-direct-marketing.online/api/v1/me', {
headers: { Authorization: 'Bearer ' + process.env.ICP_KEY }
});
if (!response.ok) throw new Error('HTTP ' + response.status);
console.log(await response.json());Python (requests)
import os, requests
response = requests.get(
'https://check.live-direct-marketing.online/api/v1/me',
headers={'Authorization': 'Bearer ' + os.environ['ICP_KEY']},
timeout=30,
)
response.raise_for_status()
print(response.json())Uyğunluq
Mövcud v1 sınaq CRUD əməliyyatları, icazəli xidmət siyahıları, ekran görüntüsü funksiyaları və açar üzrə limitlər dəstəklənir. Hesaba giriş, yenidən göstərilə bilən yeni açarlar, sorğu tarixçəsi və pulsuz paket müraciətləri mövcud açarları dəyişmədən bu API-ni genişləndirir.