Doiciméadú API

Tagairt API

Comhtháthaigh MailAudit i d’fheidhmchlár féin: seiceálacha DNS, liostaí dubha agus clú, chomh maith le tástálacha iomlána in‑seachadthachta ríomhphoist trí REST API.

Teorainn ráta

60 iarratas / nóiméad, 1,000 / lá in aghaidh na heochrach

Bun‑URL

https://api.mailaudit.io/api/v1

Fíordheimhniú

Teastaíonn eochair API do gach iarratas. Seol í sa cheanntásc Authorization mar chomhartha Bearer (nó sa cheanntásc X-API-Key). Coinnigh d’eochair faoi rún — ná leabaigh í i gcód brabhsálaí.

bash
curl -H "Authorization: Bearer ma_live_xxxxxxxxxxxx" \
  "https://api.mailaudit.io/api/v1/tools/mx-check?domain=example.com"

Bíonn na ceanntásca X-RateLimit-Remaining agus X-RateLimit-Daily-Remaining i ngach freagra. Nuair a sháraítear teorainn, faigheann tú HTTP 429 le ceanntásc Retry-After.

Faigh eochair API

Críochphointí

Seiceáil taifead MX

GET/tools/mx-check

Fiosraigh taifid MX an fhearainn, chomh maith le socruithe SPF agus DMARC.

Paraiméadair

domainstringriachtanach
Ainm an fhearainn le seiceáil (m.sh. example.com)

Iarratas samplach

bash
curl -H "Authorization: Bearer $MAILAUDIT_API_KEY" \
  "https://api.mailaudit.io/api/v1/tools/mx-check?domain=gmail.com"

Sampla freagartha

json
1{
2  "domain": "gmail.com",
3  "hasMx": true,
4  "records": [
5    {
6      "exchange": "gmail-smtp-in.l.google.com",
7      "priority": 5,
8      "ip": ["142.250.150.27"]
9    },
10    {
11      "exchange": "alt1.gmail-smtp-in.l.google.com",
12      "priority": 10,
13      "ip": ["142.250.141.26"]
14    }
15  ],
16  "hasSpf": true,
17  "spfRecord": "v=spf1 redirect=_spf.google.com",
18  "hasDmarc": true,
19  "dmarcRecord": "v=DMARC1; p=none; sp=quarantine; rua=mailto:..."
20}

Seiceáil liosta dubh

GET/tools/blacklist-check

Seiceáil an bhfuil seoladh IP nó fearann ar phríomhliostaí blocála turscair (32 DNSBL).

Paraiméadair

querystringriachtanach
Seoladh IP (m.sh. 192.168.1.1) nó ainm fearainn

Iarratas samplach

bash
curl -H "Authorization: Bearer $MAILAUDIT_API_KEY" \
  "https://api.mailaudit.io/api/v1/tools/blacklist-check?query=8.8.8.8"

Sampla freagartha

json
1{
2  "query": "8.8.8.8",
3  "queryType": "ip",
4  "totalChecked": 32,
5  "totalListed": 0,
6  "results": [
7    {
8      "name": "Spamhaus ZEN",
9      "zone": "zen.spamhaus.org",
10      "listed": false,
11      "responseTime": 45
12    },
13    {
14      "name": "Barracuda",
15      "zone": "b.barracudacentral.org",
16      "listed": false,
17      "responseTime": 32
18    }
19    // ...
20  ]
21}

Seiceáil chlú an fhearainn

GET/tools/reputation

Ríomh cuimsitheach ar scór clú an fhearainn. Seiceálann sé SPF, DKIM, DMARC, taifid MX, stádas liosta dubh, tacaíocht STARTTLS, aois an fhearainn agus reverse DNS.

Paraiméadair

domainstringriachtanach
Ainm an fhearainn le seiceáil (m.sh. gmail.com)

Iarratas samplach

bash
curl -H "Authorization: Bearer $MAILAUDIT_API_KEY" \
  "https://api.mailaudit.io/api/v1/tools/reputation?domain=gmail.com"
Scála Grádaithe
90-100 = A+
80-89 = A
70-79 = B
60-69 = C
50-59 = D
0-49 = F

Sampla freagartha

json
1{
2  "domain": "gmail.com",
3  "ip": "142.250.150.27",
4  "score": 100,
5  "grade": "A+",
6  "factors": [
7    { "name": "SPF", "status": "pass", "detail": "Policy: present", "impact": 15 },
8    { "name": "DKIM", "status": "warn", "detail": "Not found", "impact": 0 },
9    { "name": "DMARC", "status": "warn", "detail": "Policy: none", "impact": 5 },
10    { "name": "MX Records", "status": "pass", "detail": "5 record(s)", "impact": 10 },
11    { "name": "Blacklists", "status": "pass", "detail": "Clean (39 checked)", "impact": 20 },
12    { "name": "STARTTLS", "status": "pass", "detail": "Supported", "impact": 10 },
13    { "name": "Domain Age", "status": "pass", "detail": "30.3 years", "impact": 10 },
14    { "name": "Reverse DNS", "status": "pass", "detail": "wa-in-f27.1e100.net", "impact": 5 }
15  ],
16  "details": {
17    "mx": { "valid": true, "count": 5, "primary": "gmail-smtp-in.l.google.com" },
18    "spf": { "valid": true, "record": "v=spf1 redirect=_spf.google.com" },
19    "dkim": { "valid": false, "selectors": [] },
20    "dmarc": { "valid": true, "policy": "none", "rua": ["mailto:..."] },
21    "blacklists": { "checked": 10, "listed": 0, "clean": true },
22    "tls": { "valid": true, "starttls": true },
23    "domainAge": { "valid": true, "years": 30.3, "registrationDate": "1995-08-13" },
24    "rdns": { "valid": true, "hostname": "wa-in-f27.1e100.net" }
25  },
26  "checkedAt": "2025-12-03T07:05:46.232Z",
27  "cached": false
28}

Tástáil in‑seachadthachta ríomhphoist

Cruthaigh seoladh tástála, seol do ríomhphost chuige ón bhfreastalaí is mian leat a thástáil, ansin fiosraigh an toradh arís is arís go dtí gurb é completed an stádas (de ghnáth laistigh de nóiméad). Téann seoltaí tástála in éag tar éis uair an chloig.

POST/test/generate

Cruthaigh seoladh ríomhphoist tástála nua.

Iarratas samplach

bash
curl -X POST -H "Authorization: Bearer $MAILAUDIT_API_KEY" \
  "https://api.mailaudit.io/api/v1/test/generate"

Sampla freagartha

json
1{
2  "testId": "k3v9x2m1qa",
3  "email": "[email protected]",
4  "expiresAt": "2026-09-24T18:44:14.762Z",
5  "checkUrl": "/test/k3v9x2m1qa"
6}
GET/test/{testId}

Faigh stádas agus torthaí tástála. Stádas: pending → processing → completed (nó expired / error). Is é 0–10 raon an scóir.

Paraiméadair

testIdstringriachtanach
Aitheantas na tástála a chuir /test/generate ar ais

Iarratas samplach

bash
curl -H "Authorization: Bearer $MAILAUDIT_API_KEY" \
  "https://api.mailaudit.io/api/v1/test/k3v9x2m1qa"

Sampla freagartha

json
1{
2  "testId": "k3v9x2m1qa",
3  "status": "completed",
4  "score": 9.2,
5  "createdAt": "2026-09-24T17:44:14.763Z",
6  "receivedAt": "2026-09-24T17:45:02.118Z",
7  "expiresAt": "2026-09-24T18:44:14.762Z",
8  "email": {
9    "from": "[email protected]",
10    "subject": "Our September newsletter",
11    "bounceAddress": null
12  },
13  "checks": {
14    "spf": { "status": "pass", ... },
15    "dkim": { "status": "pass", ... },
16    "dmarc": { "status": "pass", ... },
17    "blacklist": { "status": "pass", ... },
18    "spamassassin": { "status": "pass", ... }
19  }
20}
POST/test/{testId}/recheck

Rith na seiceálacha go léir arís ar ríomhphost a fuarthas cheana, gan ceann nua a sheoladh.

Paraiméadair

testIdstringriachtanach
Aitheantas na tástála a chuir /test/generate ar ais

Sampla freagartha

json
1{
2  "success": true,
3  "testId": "k3v9x2m1qa",
4  "message": "Recheck initiated - checks are running"
5}

Bosca isteach forbróra

Tá a sheoladh indiúscartha féin ag gach cuntas ([email protected], le haon +clib). Coinnítear an post a sheoltar chuige ar feadh 24 uair an chloig agus is féidir é a léamh tríd an API, ar an deais nó trí nasc comhroinnte. Úsáid é i dtástálacha ceann go ceann in ionad fíorbhosca poist.

GET/inbox/wait

Fanann sé (long-poll, suas le 60 s) go dtí go dtagann teachtaireacht a mheaitseálann, agus cuireann sé ar ais í le téacs, HTML, naisc agus cóid aonuaire. Cuireann sé 408 ar ais mura dtagann aon rud in am.

Paraiméadair

tagstring
Post a seoladh chuig dev-xxxxxx+{tag}@… amháin
timeoutnumber
Soicindí le fanacht, 1-60 (réamhshocrú 30)
sinceISO 8601
Post a fuarthas tar éis an ama seo amháin (réamhshocrú: anois)

Iarratas samplach

bash
1curl -H "Authorization: Bearer $MAILAUDIT_API_KEY" \
2  "https://api.mailaudit.io/api/v1/inbox/address?tag=signup-42"
3# → { "address": "[email protected]", … }
4
5curl -H "Authorization: Bearer $MAILAUDIT_API_KEY" \
6  "https://api.mailaudit.io/api/v1/inbox/wait?tag=signup-42&timeout=60"

Ar fáil freisin:

  • GET /inbox · GET /inbox/address · GET /inbox/messages?tag=&since=
  • GET /inbox/messages/{id} · GET /inbox/messages/{id}/raw · DELETE /inbox/messages/{id}

Sampla freagartha

json
1{
2  "id": "81ab56fe-9546-41a1-b7d1-b0f1a594ad37",
3  "to": "[email protected]",
4  "tag": "signup-42",
5  "from": { "address": "[email protected]", "name": "YourApp" },
6  "subject": "Confirm your email address",
7  "receivedAt": "2026-09-24T19:53:43.624Z",
8  "expiresAt": "2026-09-25T19:53:43.624Z",
9  "links": ["https://yourapp.dev/confirm?t=abc"],
10  "codes": ["482913"],
11  "shareUrl": "https://mailaudit.io/m/UjKgBYNGYXjTaGLe…",
12  "text": "Your code: 482 913 …",
13  "html": "<p>Your code: <b>482 913</b></p>…",
14  "headers": { "subject": "Confirm your email address", … }
15}

Úsáid ó ghníomhaire AI é (MCP)

Is freastalaí MCP an bosca isteach céanna, mar sin is féidir le Claude Code, Cursor agus cliaint MCP eile seoltaí a chruthú, fanacht le post agus é a léamh leo féin:

bash
claude mcp add --transport http mailaudit https://api.mailaudit.io/mcp \
  --header "Authorization: Bearer $MAILAUDIT_API_KEY"

Uirlisí: new_address, wait_for_message, list_messages, get_message, extract, share_link, delete_message.

Cóid Stádais HTTP

CódStádasCur síos
200OKIarratas rathúil
400Bad RequestParaiméadar ar iarraidh nó neamhbhailí
401UnauthorizedEochair API ar iarraidh, neamhbhailí nó cúlghairthe
404Not FoundNíor aimsíodh an tástáil
429Too Many RequestsSáraíodh an teorainn ráta (60/nóiméad nó 1,000/lá)
500Internal Server ErrorEarráid taobh an fhreastalaí

Freagraí Earráide

I gcás earráide, beidh réimse error sa fhreagra a thugann cur síos ar an earráid:

json
{
  "error": "Tá fearann riachtanach"
}

Samplaí Cód

JavaScript / Node.js

javascript
1// Fiosraigh taifid MX
2const response = await fetch(
3  'https://api.mailaudit.io/api/v1/tools/mx-check?domain=example.com',
4  { headers: { Authorization: `Bearer ${process.env.MAILAUDIT_API_KEY}` } }
5);
6const data = await response.json();
7
8if (data.hasMx) {
9  console.log('Taifid MX:', data.records);
10  console.log('SPF:', data.hasSpf ? data.spfRecord : 'Faic');
11  console.log('DMARC:', data.hasDmarc ? data.dmarcRecord : 'Faic');
12}

Python

python
1import os
2import requests
3
4# Seiceáil liosta dubh
5response = requests.get(
6    'https://api.mailaudit.io/api/v1/tools/blacklist-check',
7    params={'query': '192.168.1.1'},
8    headers={'Authorization': f"Bearer {os.environ['MAILAUDIT_API_KEY']}"},
9)
10data = response.json()
11
12print(f"Seiceáilte: {data['totalChecked']} liosta")
13print(f"Liostaithe ar: {data['totalListed']} áit")
14
15for result in data['results']:
16    if result['listed']:
17        print(f"⚠️  {result['name']}: LIOSTAITHE")

Python - Reputation Check

python
1import os
2import requests
3
4# Seiceáil chlú fearainn
5response = requests.get(
6    'https://api.mailaudit.io/api/v1/tools/reputation',
7    params={'domain': 'example.com'},
8    headers={'Authorization': f"Bearer {os.environ['MAILAUDIT_API_KEY']}"},
9)
10data = response.json()
11
12print(f"Score: {data['score']}/100 ({data['grade']})")
13print("\nFachtóirí:")
14for factor in data['factors']:
15    icon = "✅" if factor['status'] == 'pass' else "⚠️" if factor['status'] == 'warn' else "❌"
16    print(f"  {icon} {factor['name']}: {factor['detail']} ({factor['impact']:+d})")

Python - Email deliverability test

python
1import os
2import time
3import requests
4
5# Tástáil iomlán in‑seachadthachta
6api = 'https://api.mailaudit.io/api/v1'
7headers = {'Authorization': f"Bearer {os.environ['MAILAUDIT_API_KEY']}"}
8
9test = requests.post(f'{api}/test/generate', headers=headers).json()
10print('Send your email to:', test['email'])
11
12while True:
13    result = requests.get(f"{api}/test/{test['testId']}", headers=headers).json()
14    if result['status'] in ('completed', 'expired', 'error'):
15        break
16    time.sleep(10)
17
18print(f"Status: {result['status']}, score: {result['score']}/10")

PHP

php
1<?php
2// Seiceáil MX
3$domain = 'example.com';
4$url = "https://api.mailaudit.io/api/v1/tools/mx-check?domain=" . urlencode($domain);
5
6$context = stream_context_create(['http' => [
7    'header' => 'Authorization: Bearer ' . getenv('MAILAUDIT_API_KEY'),
8]]);
9$response = file_get_contents($url, false, $context);
10$data = json_decode($response, true);
11
12if ($data['hasMx']) {
13    foreach ($data['records'] as $mx) {
14        echo "MX: {$mx['exchange']} (tosaíocht: {$mx['priority']})\n";
15    }
16}
17?>

Ar mhaith leat triail a bhaint as an API?

Bain triail as ár n‑uirlisí san chomhéadan gréasáin, nó tosaigh ag forbairt leis an API.