Inbox Check-თან დაკავშირება
უფასოდ დაიწყეთ საჯარო API-ით ან ჩამოტვირთეთ SDK. ანგარიში და API გასაღები საჭირო არ არის.
უფასო API — დაიწყეთ შესვლის გარეშე
გამგზავნის ელფოსტა ტესტის ტექნიკური მონაცემია. ჩაანაცვლეთ you@example.com იმ მისამართით, საიდანაც გააგზავნით წერილს.
JavaScript / Python SDK-ის გამოყენება · ბრაუზერში გაშვება
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-ით ან გახსენით 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, სანამ სტატუსი done ან expired გახდება. დროის ამოწურვის შემდეგ იმავე ტოკენით შეგიძლიათ გაგრძელება.
ეს კლიენტები იყენებს საჯარო /api/tests მისამართს. MCP-ის სტუმრის დისტანციური ინსტრუმენტებიც გასაღების გარეშე მუშაობს. გამოიყენეთ MCP ინსტრუქცია. დაყენების ყველა მიმდინარე ვარიანტი ჩამოთვლილია /sdk/integration.json მისამართზე.
ვებჰუკები რეგისტრაციის გარეშე: ადგილობრივი SDK გადამცემი
თქვენს AI-ს შეუძლია გადამცემის ჩამოტვირთვა და დაყენება თქვენს Node.js გარემოში. გადამცემი კითხულობს შენახულ ტესტის ტოკენს, ელოდება საბოლოო done/expired შედეგს და მიმღებს ერთ ხელმოწერილ check.completed მოვლენას უგზავნის. პროცესი გაშვებული დატოვეთ. ეს ფუნქცია ადგილობრივ გადამცემს იყენებს.
ვებჰუკის გადამცემისა და ხელმოწერის შემმოწმებლის ჩამოტვირთვა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 მწკრივის ნახვა. დაფარვა მითითებული თარიღიდან იწყება. უფრო ძველი ჩანაწერები შესაძლოა არასრული იყოს. მოთხოვნის სხეული, ქუქი-ფაილები და საიდუმლო მონაცემები არ ინახება.
უფრო დიდი უფასო პაკეტის მოთხოვნა
ანგარიშში აირჩიეთ „უფასო პაკეტის მოთხოვნა“. დამტკიცების შემდეგ არჩეული გასაღების ლიმიტები იქნება დღეში 500 და თვეში 5 000. ახალი ლიმიტები ჩაანაცვლებს არსებულს. გამოყენებული შემოწმებების რაოდენობა შენარჩუნდება და დამატებითი შემოწმებები ცალკე არ მიემატება. დამტკიცებამდე მოქმედებს მიმდინარე ლიმიტები. გადაწყვეტილებას ელფოსტით მიიღებთ.
მომხმარებელთან დაკავშირებული account:read უფლების მქონე გასაღებით საკუთარი მოთხოვნების წაკითხვა შესაძლებელია GET /api/v1/account/promo-requests მისამართზე. კითხვის უფლება მოთხოვნების შექმნისა და დამტკიცების უფლებას არ იძლევა. პაკეტის მოსათხოვად შედით ანგარიშში.
თუ მოთხოვნა ვერ შესრულდა
მხოლოდ მართვადი API: 401-ისას შეამოწმეთ Bearer გასაღები, 403-ისას — მისი უფლებები. quota_exceeded-ისას შეამოწმეთ ორივე ლიმიტი. გაითვალისწინეთ 429/Retry-After. სერვერის შეცდომისას POST-ის გამეორებამდე გაარკვიეთ შექმნის შედეგი. მხარდაჭერასთან დაკავშირებისას შეინახეთ requestId, თუმცა გასაღები არ გაგზავნოთ.
სრული API ცნობარი და ინტეგრაციები
ახალ ნაგულისხმევ გასაღებებს მხოლოდ თქვენი მონიტორინგის უფლებები აქვთ ადმინისტრატორის წვდომის გარეშე. არსებული გასაღებების უფლებები შენარჩუნებულია. შეზღუდული გასაღების არჩევა კვლავ შესაძლებელია ანგარიშის პარამეტრებში.
ვრცელი ცნობარი: 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-ის მნიშვნელობები.
| გეგმა | დღეში | თვეში | ეკრანის სურათები |
|---|---|---|---|
| basic | 100 | 1,000 | — |
| pro | 500 | 10,000 | გათვალისწინებულია |
| enterprise | 5,000 | 100,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())თავსებადობა
არსებული v1 ტესტების CRUD, დაშვებული პროვაიდერების სიები, ეკრანის სურათები და თითოეული გასაღების კვოტა კვლავ მხარდაჭერილია. ანგარიშში შესვლა, აღდგენადი ახალი გასაღებები, მოთხოვნების ისტორია და უფასო პაკეტის მოთხოვნები API-ს აფართოებს არსებული გასაღებების შეცვლის გარეშე.