Inbox Placement Testby Live Direct Marketing

Выберыце мову

Увайсці

Падключыцца да Inbox Check

Пачніце бясплатна з публічнага API або спампуйце SDK. Уліковы запіс і ключ API не патрабуюцца.

Бясплатны API — пачніце без уваходу

Адрас адпраўніка — тэхнічны параметр праверкі. Рэгістрацыя і пацверджанне не патрабуюцца. Замяніце you@example.com адрасам, з якога будзеце адпраўляць.

Выкарыстоўвайце SDK для JavaScript або Python · Запусціць у браўзеры

1. Стварыце бясплатную праверку

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}'

Адказ змяшчае token, send_to, results_url і expires_at. Захавайце іх, перш чым закрыць тэрмінал. У прыкладах выключаны лісты з напамінамі і справаздачамі. Лісты для ўваходу не запытваюцца.

2. Адпраўце свой ліст

Адпраўце ліст для праверкі з гэтага адраса праз звычайны паштовы сэрвіс на ЎСЕ адрасы ў send_to. Стварэнне праверкі не адпраўляе ліст за вас.

3. Прачытайце вынік

curl https://check.live-direct-marketing.online/api/tests/YOUR_TEST_TOKEN

Замяніце YOUR_TEST_TOKEN значэннем token з кроку 1 або адкрыйце results_url. Падчас чакання апытвайце кожныя некалькі секунд. Правярайце results, summary і authentication: адзін канчатковы статус не пацвярджае дастаўку ва «Уваходныя». Захоўвайце токен у сакрэце. Для чытання справаздачы ўліковы запіс не патрэбны.

400: выпраўце запыт. 429: дачакайцеся resetAt / Retry-After. Пры збоі сеткі падчас стварэння праверкі вынік невядомы. Не паўтарайце POST аўтаматычна. Захоўвайце токен падчас апытання. Пры заканчэнні агульнага часу чакання вяртаюцца токен і апошні здымак стану, каб вы маглі працягнуць без уваходу.

Гасцявы SDK: JavaScript і Python

Спампуйце кліент, які падтрымліваецца, непасрэдна. Патрэбны Node.js 18+ або Python 3.9+. Менеджар пакетаў, залежнасці і ключ API не патрабуюцца.

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.

Працягвайце з захаваным токенам і не стварайце іншую праверку

Пасля адпраўкі ліста запусціце асобны скрыпт з тым самым токенам. Паўторны запуск скрыпта стварэння зробіць іншую праверку з іншымі тэставымі адрасамі.

// 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 вяртае першы замераны здымак стану паштовага сэрвісу або канчатковы вынік. Ён можа быць частковым. Праверце status і results. Калі патрэбная поўная выніковая справаздача, працягвайце выклікаць getTest / get_test з тым самым токенам, пакуль status не будзе done або expired. Пасля заканчэння часу чакання можна працягнуць з тым самым токенам.

Гэтыя кліенты выкарыстоўваюць публічны /api/tests. Аддаленыя гасцявыя інструменты MCP таксама працуюць без ключа. Скарыстайцеся інструкцыямі MCP. Усе бягучыя варыянты наладжвання пералічаны ў /sdk/integration.json.

Вэбхукі без рэгістрацыі: лакальны рэтранслятар SDK

Ваш ШІ можа спампаваць і наладзіць гэты рэтранслятар у вашым асяроддзі Node.js. Ён чытае ЗАХАВАНЫ токен праверкі, чакае канчатковага стану done/expired, а потым адпраўляе адну падпісаную падзею check.completed вашаму атрымальніку. Пакіньце працэс запушчаным. Гэта лакальны механізм без падпіскі на вэбхукі Check.

Спампаваць рэтранслятар вэбхукаў і сродак праверкі подпісу
curl -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 і YOUR_RECEIVER ужо створаным токенам і ўласным атрымальнікам HTTPS. Наладжванне запісвае новы закрыты файл з выпадковым сакрэтам подпісу. Існы файл не перазапісваецца.

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

Перад запускам наладзьце атрымальніка з тым самым закрытым сакрэтам. Правярайце зыходнае цела запыту, X-Inbox-Check-Timestamp і X-Inbox-Check-Signature. Подпіс: sha256=HMAC-SHA256(secret, timestamp + "." + rawBody). Адхіляйце састарэлыя пазнакі часу і выдаляйце дублікаты паводле event.id.

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.

Рэтранслятар не стварае праверкі і не адпраўляе тэставыя лісты. Ён не паўтарае зваротныя POST і не пераходзіць па перанакіраваннях. Калі дастаўка зваротнага выкліку няпэўная, памылка змяшчае eventId. Праверце атрымальніка перад паўторным запускам. Калі час апытання скончыўся, захавайце токен і канфігурацыю ды працягніце тую самую праверку. Вынік без атрыманых лістоў, тэрмін якога скончыўся, захоўвае гэты стан.

Неабавязковы ўліковы запіс, вышэйшыя ліміты і кіраваныя інтэграцыі

Ваш ключ падключэння

Увайдзіце па спасылцы з ліста. Першы пацверджаны ўваход аўтаматычна створыць уліковы запіс і ключ.

Стварыць уліковы запісУвайсціАдкрыць уліковы запіс

Базавы план: першапачаткова 100 праверак за дзень і 1 000 за месяц, без здымкаў экрана. Уліковы запіс і me_get паказваюць дакладныя ліміты і выкарыстанне. Запытайце бясплатны пакет 500/5 000 ва ўліковым запісе. Ён пачне дзейнічаць пасля зацвярджэння.

Пасля ўваходу можна зноў паказаць і скапіяваць новыя ключы. Старыя ключы працуюць, але аднавіць іх значэнні немагчыма. Стварыце новы ключ, абнавіце інтэграцыю, потым адклічце стары. Захоўвайце ключ у сакрэце.

1. Праверце падключэнне

Замяніце YOUR_API_KEY сваім ключом. GET /api/v1/me паказвае ліміты гэтага ключа і астатак праверак. Чытанне не расходуе праверку.

curl https://check.live-direct-marketing.online/api/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"

2. Стварыце праверку

Адна паспяхова створаная праверка расходуе адну праверку з квоты. Выбірайце паштовыя сэрвісы, даступныя вашаму ключу праз GET /api/v1/providers.

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. Адпраўце свой ліст

Адказ змяшчае адрасы send_to і results_url. Адпраўце ліст з уласнага паштовага сэрвісу на ЎСЕ вернутыя адрасы. Стварэнне праверкі не адпраўляе ліст за вас.

4. Адкрыйце справаздачу

Адкрыйце results_url або атрымайце вынік праз GET /api/v1/tests/:token. Чытанне вынікаў не расходуе праверку. Час дастаўкі розніцца. Адсутнасць ліста не пацвярджае паспяховай дастаўкі.

Ліміты і гісторыя

Базавы план пачынаецца са 100 праверак за дзень і 1 000 за месяц. Дакладныя ліміты могуць адрознівацца. Выкарыстоўвайце /api/v1/me для бягучага ключа, а ўліковы запіс — для ўсіх ключоў. Даступная колькасць праверак роўная меншаму з дзённага і месячнага астаткаў.

Перыяды скідаюцца а 00:00 UTC кожны дзень і ў першы дзень месяца. Ва ўліковым запісе час скіду паказаны ў вашым мясцовым часе. Запыты API і няўдалыя запыты падлічваюцца асобна ад праверак.

У гісторыі ўліковага запісу 30 дзён захоўваюцца падрабязнасці запытаў. Даступныя фільтры і старонкі па 20 або 50 радкоў. Ахоп пачынаецца з паказанай там даты. Ранейшыя запісы могуць быць няпоўнымі. Целы запытаў, файлы cookie і сакрэты не захоўваюцца.

Запытаць большы бясплатны пакет

Выберыце «Запытаць бясплатны пакет» ва ўліковым запісе. Пасля зацвярджэння ліміты выбранага ключа складуць 500 за дзень і 5 000 за месяц. Новыя ліміты замяняюць ранейшыя без дадавання праверак і скіду выкарыстання. Да зацвярджэння дзейнічаюць бягучыя ліміты. Рашэнне прыйдзе па пошце.

Ключ, прывязаны да карыстальніка, з правам account:read можа чытаць свае запыты праз GET /api/v1/account/promo-requests. Права чытання не дазваляе ствараць або зацвярджаць запыты. Каб запытаць пакет, увайдзіце ва ўліковы запіс.

Калі запыт не ўдаўся

Толькі для кіраванага API: пры 401 праверце ключ Bearer, пры 403 — яго дазволы. Пры quota_exceeded праверце абодва ліміты. Улічвайце 429/Retry-After. Пасля памылкі сервера праверце вынік перад паўторам POST стварэння. Пры звароце ў падтрымку пазначайце requestId, але не перадавайце ключ.

Поўны даведнік API і інтэграцый

OpenAPI · MCP · A2A

Новыя ключы па змаўчанні даюць абмежаваныя правы на ўласны маніторынг без доступу адміністратара. Правы ранейшых ключоў захоўваюцца. Ключы з абмежаванымі правамі можна выбраць асобна ў наладах уліковага запісу.

Пашыраны даведнік: адрасы API, планы і код

OpenAPI пералічвае маршруты і даступныя схемы запытаў. Некаторыя схемы адказаў не аб’яўленыя. Карыстайцеся прыкладамі і фактычнымі палямі адказу. Кіраваныя выклікі выкарыстоўваюць Authorization: Bearer YOUR_API_KEY. Для змен маніторынгу патрэбны monitoring:write, а для чытання — monitoring:read і ключ, прывязаны да карыстальніка.

GET /api/v1/me
Метаданыя ключа, функцыі, дазволеныя паштовыя сэрвісы, квота і час скіду ў UTC.
GET /api/v1/providers
Даступныя гэтаму ключу паштовыя сэрвісы.
POST /api/v1/tests
Стварыце праверку. Адказ 202 змяшчае token, send_to і results_url.
GET /api/v1/tests
Атрымайце спіс сваіх праверак з разбіццём на старонкі праз cursor і limit.
GET /api/v1/tests/:token
Прачытайце вынікі размяшчэння, аўтэнтыфікацыю, дыягностыку і даступныя URL здымкаў.
DELETE /api/v1/tests/:token
Назаўсёды выдаліце сваю праверку, вынікі і здымкі экрана.
GET /api/v1/monitoring/domains
Атрымайце спіс даменаў пад маніторынгам, агульны для сайта і Telegram.
POST /api/v1/monitoring/domains
Дадайце свой дамен: {"domain":"example.com"}.
POST /api/v1/monitoring/domains/:id/pause
Прыпыніце маніторынг вашага дамена.
POST /api/v1/monitoring/domains/:id/resume
Аднавіце маніторынг вашага дамена.
DELETE /api/v1/monitoring/domains/:id
Выдаліце дамен з маніторынгу.
GET /api/v1/account/promo-requests
Прачытайце свае запыты бясплатнага пакета з правам account:read.

Стандартныя планы

Аператары могуць задаваць індывідуальныя налады ключоў. Фактычныя ліміты заўсёды правярайце паводле значэнняў API.

ПланЗа дзеньЗа месяцЗдымкі экрана
basic1001,000—
pro50010,000уключана
enterprise5,000100,000уключана

Node / Python

Асобны SDK не патрэбны. Захоўвайце ключ у закрытай зменнай асяроддзя па-за сістэмай кантролю версій.

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())

Сумяшчальнасць

Ранейшыя аперацыі CRUD для праверак v1, спісы дазволеных паштовых сэрвісаў, здымкі экрана і квоты ключоў падтрымліваюцца далей. Уваход, новыя ключы, якія можна аднавіць, гісторыя запытаў і запыты бясплатнага пакета пашыраюць API без змены існых ключоў.