Dokumentacioni API

GPTMail API

Përdorni API-në e GPTMail për të krijuar kuti postare të përkohshme, për të listuar e lexuar mesazhe dhe për të fshirë emaile përmes HTTPS me kokën X-API-Key. Është e përshtatshme për teste të automatizuara, pipeline CI/CD dhe rrjedha pune QA.

Si të marrësh një 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

Opsioni 2: Shto domain-in tënd

Pasi domeni publik kalon verifikimin MX: dërguar pa hyrë në llogari → çelës API (20000 kërkesa); dërguar pasi keni hyrë → 200 pikë. Çdo domen merr vetëm një shpërblim. E rëndësishme: pasi të lidhet, mbaresën e atij domain-i e bën mbaresë publike për të gjithë përdoruesit e kësaj faqeje, kështu që edhe përdoruesit e tjerë mund të gjenerojnë adresa kutie nën të. Pas aktivizimit, mos fshi, mos zëvendëso dhe mos ndrysho regjistrin MX që e drejton këtë domain te shërbimi ynë. Përndryshe, kontrollet e mëvonshme mund ta konsiderojnë domain-in keq konfiguruar. Nëse një kontroll i mëvonshëm gjen regjistrin MX të pavlefshëm, domain-i çaktivizohet. Nëse regjistri MX mbetet i pavlefshëm për 3 kontrolle radhazi, edhe API Key përkatëse çaktivizohet. Nëse regjistri MX bëhet përsëri i vlefshëm më vonë, domain-i riaktivizohet automatikisht.

Domenet

Çelësi publik i testimit

Për testim, dërgoni çelësin publik të përbashkët që shfaqet më poshtë në kokën X-API-Key. Ai ndryshon çdo ditë dhe ka një kufi ditor prej 200.000 kërkesash, të ndarë mes të gjithë përdoruesve.

Mbetur sot

Rivendoset pas

Duke ngarkuar kuotën e drejtpërdrejtë për çelësin publik...

Referenca API më poshtë mund të kopjohet si Markdown për mjete AI, baza njohurish ose një README.

URL Bazë: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Fillim i shpejtë

  • X-API-Key: YOUR_KEY është opsioni më i thjeshtë. Për teste të shpejta, përdorni çelësin publik ditor që shfaqet më lart në vend të YOUR_KEY.

  • Shumica e pikave fundore të kutisë kërkojnë parametër email, p.sh. ?email=demo@example.com.

  • Përgjigjet e GPTMail API përdorin JSON me fushat success, data dhe error, si dhe usage kur përdoret një çelës API. Gabimet e Cloudflare, përfshirë përgjigjet për kufirin e shpeshtësisë, mund të kthejnë HTML në vend të JSON. Kontrolloni statusin HTTP dhe Content-Type para se të analizoni JSON-in.

  • Nëse tashmë njeh një domain të mbështetur në këtë faqe, nuk duhet të thërrasësh fillimisht pikën e gjenerimit të email-it. Mund të përbësh prefix@domain lokalisht dhe të thërrasësh drejtpërdrejt API-t e kutisë, duke kursyer një API request.

Kufijtë e shpeshtësisë së kërkesave dhe riprovimet

  • GET dhe POST /api/generate-email ndajnë një kufi prej 30 kërkesash për 10 sekonda për çdo IP burimore. Kjo vlen si për çelësat API publikë, ashtu edhe për ata personalë. Çelësa dhe klientë të ndryshëm pas së njëjtës IP e ndajnë këtë kufi.

  • Tejkalimi i këtij kufiri kthen HTTP 429 dhe bllokon krijimin e email-eve për 10 sekonda. Prisni kohën e treguar nga Retry-After para se të riprovoni. Nëse ky header mungon, prisni të paktën 10 sekonda dhe më pas riprovoni me vonesa gjithnjë e më të gjata. Shmangni riprovimet e njëkohshme nga klientë që ndajnë të njëjtën IP.

  • Ky rregull nuk vlen për listimin e kutisë hyrëse ose leximin e email-eve të veçanta. Kuotat ditore dhe totale të çelësave API vazhdojnë të zbatohen në mënyrë të pavarur. Pritja prej 10 sekondash nuk e rikthen kuotën e shteruar të çelësit.

Pikat kryesore fundore

POST / GET
/api/generate-email

Gjenero një kutinë e përkohshme. Përdor GET për rrjedhën më të thjeshtë të kutisë të rastësishme, ose POST me prefix dhe domain kur dëshiron kontroll të qartë.

GET
/api/emails?email=...

Merr email-et për një kutinë postare.

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

Merr një email të vetëm, përfshirë tekstin, HTML, header-at e papërpunuara dhe metadatat.

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

Fshi një email sipas ID-së.

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

Fshi të gjithë email-et në një kutinë postare.

GET
/api/stats

Lexo statistikat e gjithë faqes.

Shembull rrjedhe

Më poshtë janë dy modele të zakonshme: lë shërbimin të gjenerojë një kutinë për ty, ose kërko një prefiks të fiksuar. Nëse tashmë njeh një domain të mbështetur aktualisht, mund të përbësh kutinë lokalisht dhe ta pyesësh drejtpërdrejt.

1) Gjenero një adresë email të përkohshme të rastësishme

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Shembull përgjigjeje
{
  "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) Gjenero me prefiks të fiksuar (p.sh. 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"}'
Shembull përgjigjeje
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Listo email-et në një kutinë

Nëse njeh një domain të mbështetur, anashkalo hapin 1 dhe pyet drejtpërdrejt.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Shembull përgjigjeje
{
  "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) Lexo një email të vetëm — përfshin tekst të thjeshtë, trup HTML dhe metadatat

Zëvendësoni EMAIL_ID me një id të kthyer nga hapi 3. Kaloni gjithashtu adresën e kutisë postare si parametrin email (edhe për fshirjet dhe shkarkimet e bashkëngjitjeve): kështu emaili lexohet drejtpërdrejt nga kutia e tij postare në vend që të kërkohet sipas ID-së. Me një kyç API parametri email është opsional, por dërgimi i tij e bën kërkimin më të shpejtë.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Shembull përgjigjeje
{
  "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) Fshi një email sipas ID-së

Me një kyç API parametri email është opsional, por dërgimi i tij e bën kërkimin më të shpejtë.

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

6) Pastro të gjithë kutinë — fshin të gjithë email-et për këtë adresë

Çdo thirrje fshin një grup. Për sa kohë që përgjigjja ka "has_more": true, thirre përsëri derisa të kthejë false.

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

Forma e përgjigjes

Përgjigjet e suksesshme zakonisht duken kështu. Nëse autentikohesh me një API Key, vëre kuotën brenda 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
  }
}

Statistika të zgjeruara

  • /api/statistics/24h kthen një dritare 24-orëshe me shpërndarjen sipas orëve; përdorni offset=1,2,... për dritaret më të vjetra.
  • /api/statistics/top-subjects kthen subjektet më të shpeshta të email-eve.
  • /api/statistics/top-domains kthen domain-et më aktive.
  • /api/statistics/top-senders kthen dërguesit më aktivë.
GPTMail