API dokumentācija

GPTMail API

Izmantojiet GPTMail API, lai ģenerētu pagaidu iesūtnes, skatītu ziņojumu sarakstus, lasītu ziņojumus un dzēstu pastu, izmantojot HTTPS un galveni X-API-Key. Tas ir piemērots automatizētiem testiem, CI/CD konveijeriem un QA darbplūsmām.

Kā iegūt API Key

Buy API requests

Purchase API requests with GPTMail points. Earn points through daily check-ins and public domains, or buy points with LDC at a 1:1 rate.

Buy with points / add requests

2. variants: Pievienojiet savu domēnu

Kad publisks domēns iztur MX pārbaudi: iesniegts bez pierakstīšanās → API atslēga (20000 pieprasījumu); iesniegts pēc pierakstīšanās → 200 punktu. Katrs domēns saņem tikai vienu atlīdzību. Svarīgi: pēc savienošanas šis domēna sufikss kļūst par publisku sufiksu visiem lietotājiem, tāpēc arī citi var ģenerēt pasta adreses zem tā. Pēc aktivizēšanas nedzēsiet, neaizstājiet un nemodificējiet MX ierakstu, kas novirza domēnu uz mūsu pakalpojumu. Pretējā gadījumā vēlākās pārbaudes var uzskatīt domēnu par nepareizi konfigurētu. Ja pārbaude konstatē nederīgu MX ierakstu, domēns tiks deaktivizēts. Ja MX ieraksts paliek nederīgs 3 secīgās pārbaudēs, saistītais API Key arī tiks deaktivizēts. Ja MX ieraksts vēlreiz kļūst derīgs, domēns tiks automātiski atkārtoti aktivizēts.

Domēni

Publiskā testēšanas atslēga

Testēšanai sūtiet zemāk redzamo koplietojamo publisko atslēgu galvenē X-API-Key. Tā mainās katru dienu, un tai ir dienas limits – 200 000 pieprasījumu, ko koplieto visi lietotāji.

Atlikuši šodien

Atiestatīšana pēc

Ielādē pašreizējo publiskā atslēgas kvotu...

Zemāk esošo API atsauci var kopēt kā Markdown AI rīkiem, zināšanu bāzēm vai README.

Bāzes adrese: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Ātra sākšana

  • X-API-Key: YOUR_KEY ir vienkāršākā iespēja. Ātriem testiem YOUR_KEY vietā izmantojiet iepriekš parādīto dienas publisko atslēgu.

  • Lielākajai daļai pastkastes endpointu nepieciešams parametrs email, piemēram ?email=demo@example.com.

  • GPTMail API atbildes izmanto JSON ar laukiem success, data un error, kā arī usage, ja tiek izmantota API atslēga. Cloudflare kļūdas, tostarp atbildes par ātruma ierobežojuma pārsniegšanu, tā vietā var atgriezt HTML. Pirms JSON parsēšanas pārbaudiet HTTP statusu un Content-Type.

  • Ja jau zināt šajā vietnē atbalstītu domēnu, nav jāizsauc vispirms email ģenerēšanas endpoint. Lokāli var salikt prefix@domain un tieši izsaukt pasta API — tas ietaupa vienu API pieprasījumu.

Ātruma ierobežojumi un atkārtoti mēģinājumi

  • GET un POST /api/generate-email kopīgi ierobežo līdz 30 pieprasījumiem 10 sekundēs no viena avota IP. Tas attiecas gan uz publiskajām, gan personīgajām API atslēgām. Šo ierobežojumu koplieto dažādas atslēgas un klienti, kas izmanto vienu un to pašu IP.

  • Pārsniedzot šo ierobežojumu, tiek atgriezts HTTP 429 un e-pasta adrešu ģenerēšana tiek bloķēta uz 10 sekundēm. Pirms atkārtota mēģinājuma nogaidiet Retry-After norādīto laiku. Ja šīs galvenes nav, nogaidiet vismaz 10 sekundes un pēc tam mēģiniet vēlreiz ar pieaugošiem intervāliem. Izvairieties no vienlaicīgiem atkārtotiem mēģinājumiem no klientiem, kas izmanto vienu IP.

  • Šis noteikums neattiecas uz iesūtnes ziņojumu saraksta skatīšanu vai atsevišķu e-pastu lasīšanu. API atslēgas dienas un kopējās kvotas joprojām darbojas neatkarīgi. 10 sekunžu gaidīšana neatjauno izsmeltu atslēgas kvotu.

Galvenie endpointi

POST / GET
/api/generate-email

Izveidojiet īslaicīgu pastkasti. Izmantojiet GET vienkāršākajam nejaušajam plūsmas scenārijam vai POST ar prefix un domain, kad vēlaties skaidru kontroli.

GET
/api/emails?email=...

Iegūt email ziņas pastkastei.

GET
/api/email/{id}?email=...

Iegūt vienu email ziņu, ieskaitot tekstu, HTML, neapstrādātas galvenes un metadatus.

DELETE
/api/email/{id}?email=...

Dzēst vienu ziņu pēc ID.

DELETE
/api/emails/clear?email=...

Dzēst visas ziņas pastkastē.

GET
/api/stats

Lasīt visas vietnes statistiku.

Plūsmas piemērs

Zemāk ir divi bieži lietoti veidi: ļaut pakalpojumam ģenerēt kasti vai pieprasīt fiksētu prefiksu. Ja jau zināt atbalstītu domēnu, adresi var salikt lokāli un tieši vaicāt.

1) Ģenerēt nejaušu īslaicīgu email adresi

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Atbildes piemērs
{
  "success": true,
  "data": {
    "email": "a3f9c2b1@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 1,
    "remaining_today": 199999,
    "total_limit": 200000,
    "total_usage": 1,
    "remaining_total": 199999
  }
}

2) Ģenerēt ar fiksētu prefiksu (piem. demo@example.com)

curl -X POST 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: PUBLIC_API_KEY' \
  -d '{"prefix":"demo"}'
Atbildes piemērs
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Email ziņu saraksts pastkastē

Ja jau zināt atbalstītu domēnu, izlaidiet 1. soli un vaicājiet tieši.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Atbildes piemērs
{
  "success": true,
  "data": {
    "emails": [
      {
        "id": "e5a7f3...",
        "email_address": "demo@example.com",
        "from_address": "noreply@github.com",
        "subject": "Your code: 654321",
        "content": "Your verification code is 654321",
        "html_content": "...",
        "has_html": true,
        "timestamp": 1709654321,
        "created_at": "2024-03-05T12:18:41Z"
      }
    ],
    "count": 1
  }
}

4) Izlasīt vienu ziņu — ietver plain text, HTML ķermeni un metadatus

Aizstājiet EMAIL_ID ar id, kas atgriezts 3. solī. Nododiet arī iesūtnes adresi kā email (arī dzēšanai un pielikumu lejupielādei): tad e-pasts tiek nolasīts tieši no tā iesūtnes, nevis meklēts pēc ID. Ar API atslēgu parametrs email nav obligāts, taču tā nosūtīšana paātrina meklēšanu.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Atbildes piemērs
{
  "success": true,
  "data": {
    "id": "e5a7f3...",
    "email_address": "demo@example.com",
    "from_address": "noreply@github.com",
    "subject": "Your code: 654321",
    "content": "Your verification code is 654321",
    "html_content": "<p>Your code is 654321</p>",
    "has_html": true,
    "timestamp": 1709654321,
    "raw_size": 2048,
    "created_at": "2024-03-05T12:18:41Z"
  }
}

5) Dzēst vienu ziņu pēc ID

Ar API atslēgu parametrs email nav obligāts, taču tā nosūtīšana paātrina meklēšanu.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Atbildes piemērs
{
  "success": true,
  "data": {
    "message": "Email deleted"
  }
}

6) Iztukšot visu pastkasti — dzēš visas ziņas šai adresei

Katrs izsaukums dzēš vienu partiju. Kamēr atbildē ir "has_more": true, izsauciet vēlreiz, līdz tas atgriež false.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/emails/clear?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Atbildes piemērs
{
  "success": true,
  "data": {
    "message": "Deleted 3 emails",
    "count": 3,
    "has_more": false
  }
}

Atbildes forma

Veiksmīgas atbildes parasti izskatās šādi. Ja autentificējaties ar API Key, pievērsiet uzmanību kvotas informācijai usage.

{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 1,
    "remaining_today": 199999,
    "total_limit": 200000,
    "total_usage": 1,
    "remaining_total": 199999
  }
}

Paplašināta statistika

  • /api/statistics/24h atgriež viena 24 stundu loga sadalījumu pa stundām; ar offset=1,2,... iegūstiet vecākus logus.
  • /api/statistics/top-subjects atgriež biežākos e-pastu tematus.
  • /api/statistics/top-domains atgriež aktīvākos domēnus.
  • /api/statistics/top-senders atgriež aktīvākos sūtītājus.
GPTMail