API dokumentacija

GPTMail API

Naudodami GPTMail API per HTTPS su X-API-Key antrašte galite kurti laikinas pašto dėžutes, peržiūrėti ir skaityti laiškus bei juos ištrinti. Tai tinka automatizuotiems testams, CI/CD procesams ir QA darbo eigoms.

Kaip gauti 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 variantas: Pridėkite savo domeną

Viešam domenui praėjus MX patikrą: pateiktas neprisijungus → API raktas (20000 užklausų); pateiktas prisijungus → 200 taškų. Kiekvienas domenas gauna tik vieną atlygį. Svarbu: prijungus tą domeno priesagą ji tampa vieša ir prieinama visiems naudotojams, todėl kiti taip pat gali generuoti pašto adresus po ja. Po aktyvavimo nešalinkite, nekeiskite ir nemodifikuokite MX įrašo, nukreipiančio domeną į mūsų paslaugą. Kitu atveju vėlesnės patikros gali laikyti domeną netinkamai sukonfigūruotu. Jei patikra nustatys netinkamą MX įrašą, domenas bus deaktyvuotas. Jei MX įrašas lieka netinkamas per 3 iš eilės patikras, susietas API Key taip pat bus deaktyvuotas. Jei MX įrašas vėl tampa tinkamu, domenas bus automatiškai vėl aktyvuotas.

Domenai

Viešasis testavimo raktas

Testuodami siųskite toliau rodomą bendrą viešąjį raktą antraštėje X-API-Key. Jis keičiasi kasdien, o jo dienos limitas – 200 000 užklausų, bendras visiems naudotojams.

Liko šiandien

Atnaujinimas po

Įkeliama dabartinė viešojo rakto kvota...

Žemiau esančią API nuorodą galite kopijuoti kaip Markdown AI įrankiams, žinių bazėms ar README.

Bazinė nuoroda: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Greita pradžia

  • X-API-Key: YOUR_KEY – paprasčiausias būdas. Greitiems testams vietoj YOUR_KEY naudokite aukščiau rodomą dienos viešąjį raktą.

  • Dauguma pašto dėžutės endpointų reikalauja parametro email, pvz. ?email=demo@example.com.

  • GPTMail API atsakymai naudoja JSON su laukais success, data ir error, o naudojant API raktą – ir usage. Cloudflare klaidos, įskaitant atsakymus viršijus užklausų dažnio ribą, vietoj to gali grąžinti HTML. Prieš analizuodami JSON patikrinkite HTTP būseną ir Content-Type.

  • Jei jau žinote šiame tinklalapyje palaikomą domeną, nebūtina pirmiausia kviesti el. pašto generavimo endpoint. Galite lokaliai sudaryti prefix@domain ir tiesiogiai kviesti pašto API — tai sutaupo vieną API užklausą.

Užklausų dažnio ribos ir pakartojimai

  • GET ir POST /api/generate-email bendrai taikoma 30 užklausų per 10 sekundžių riba vienam šaltinio IP adresui. Ji galioja ir viešiesiems, ir asmeniniams API raktams. Skirtingi raktai ir klientai už to paties IP adreso dalijasi šia riba.

  • Viršijus šią ribą grąžinamas HTTP 429, o el. pašto generavimas blokuojamas 10 sekundžių. Prieš bandydami dar kartą palaukite Retry-After nurodytą laiką. Jei šios antraštės nėra, palaukite bent 10 sekundžių, tada bandykite vėl, palaipsniui ilgindami intervalus. Venkite vienu metu kartojamų užklausų iš klientų, kurie dalijasi tuo pačiu IP adresu.

  • Ši taisyklė netaikoma pašto dėžutės sąrašui ar atskirų laiškų skaitymui. API raktų dienos ir bendros kvotos toliau taikomos atskirai. Išnaudota rakto kvota neatsistato palaukus 10 sekundžių.

Pagrindiniai endpointai

POST / GET
/api/generate-email

Sukurkite laikiną pašto dėžutę. Naudokite GET paprasčiausiam atsitiktiniam srautui arba POST su prefix ir domain, kai norite aiškios kontrolės.

GET
/api/emails?email=...

Gauti el. laiškus pašto dėžutei.

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

Gauti vieną el. laišką, įskaitant tekstą, HTML, neapdorotas antraštes ir metaduomenis.

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

Ištrinti vieną laišką pagal ID.

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

Ištrinti visus laiškus pašto dėžutėje.

GET
/api/stats

Skaityti viso tinklalapio statistiką.

Pavyzdinis srautas

Žemiau du dažni būdai: leisti paslaugai sugeneruoti dėžutę arba prašyti fiksuoto priešdėlio. Jei jau žinote palaikomą domeną, adresą galite sudėti lokaliai ir tiesiogiai užklausti.

1) Sugeneruoti atsitiktinį laikiną email adresą

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Atsakymo pavyzdys
{
  "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) Generuoti su fiksuotu priešdėliu (pvz. 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"}'
Atsakymo pavyzdys
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Laiškų sąrašas pašto dėžutėje

Jei jau žinote palaikomą domeną, praleiskite 1 žingsnį ir užklauskite tiesiogiai.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Atsakymo pavyzdys
{
  "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) Perskaityti vieną laišką — apima plain text, HTML turinį ir metaduomenis

Pakeiskite EMAIL_ID 3 žingsnyje grąžintu ID. Taip pat perduokite dėžutės adresą kaip email (ir trinant bei atsisiunčiant priedus): tada laiškas skaitomas tiesiai iš jo dėžutės, o ne ieškomas pagal ID. Naudojant API raktą parametras email neprivalomas, tačiau jį nurodžius paieška vyksta greičiau.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Atsakymo pavyzdys
{
  "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) Ištrinti vieną laišką pagal ID

Naudojant API raktą parametras email neprivalomas, tačiau jį nurodžius paieška vyksta greičiau.

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

6) Išvalyti visą dėžutę — ištrina visus laiškus šiam adresui

Kiekvienas iškvietimas ištrina vieną paketą. Kol atsakyme yra "has_more": true, kvieskite dar kartą, kol bus grąžinta false.

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

Atsakymo struktūra

Sėkmingi atsakymai paprastai atrodo taip. Jei autentifikuojatės API Key, atkreipkite dėmesį į kvotos informaciją 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
  }
}

Išplėstinė statistika

  • /api/statistics/24h grąžina vieną 24 valandų pasiskirstymo pagal valandas langą; senesniems langams naudokite offset=1,2,... reikšmes.
  • /api/statistics/top-subjects grąžina dažniausias laiškų temas.
  • /api/statistics/top-domains grąžina aktyviausius domenus.
  • /api/statistics/top-senders grąžina aktyviausius siuntėjus.
GPTMail