API dokumentatsioon

GPTMaili API

GPTMaili API abil saate luua ajutisi postkaste, kirju loetleda ja lugeda ning kirju kustutada HTTPS-i kaudu X-API-Key päisega. See sobib automaattestideks, CI/CD torujuhtmetele ja QA töövoogudele.

Kuidas API võtit hankida

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

Valik 2: Lisage oma domeen

Pärast avaliku domeeni MX-kontrolli: esitatud sisse logimata → API-võti (20000 päringut); esitatud sisselogituna → 200 punkti. Iga domeen saab ainult ühe preemia. Oluline: pärast ühendamist muutub selle domeeni sufiks kõigi kasutajate jaoks avalikuks sufiksiks, seega saavad teised kasutajad selle all postkaste luua. Pärast aktiveerimist ärge kustutage, asendage ega muutke MX-kirjet, mis suunab domeeni meie teenusesse. Vastasel juhul võivad hilisemad kontrollid domeeni valesti seadistatuks lugeda. Kui kontroll leiab MX kehtetu, deaktiveeritakse domeen. Kui MX jääb 3 järjestikuse kontrolli jaoks kehtetuks, deaktiveeritakse ka seotud API võti. Kui MX muutub hiljem uuesti kehtivaks, aktiveeritakse domeen automaatselt uuesti.

Domeenid

Avalik testvõti

Testimiseks saatke allpool kuvatud jagatud avalik võti päises X-API-Key. See vahetub iga päev ja selle päevane limiit on 200 000 päringut, mida jagavad kõik kasutajad.

Jäänud täna

Lähtestub

Laen reaalajas kvooti avaliku võtme jaoks...

Allpool olevat API viidet saab kopeerida Markdownina AI tööriistade, teadmusbaaside või README jaoks.

Baas-URL: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Kiirstart

  • X-API-Key: YOUR_KEY on kõige lihtsam valik. Kiireteks testideks kasutage YOUR_KEY asemel ülal kuvatud päevast avalikku võtit.

  • Enamik postkasti lõimed nõuab parameetrit email, näiteks ?email=demo@example.com.

  • GPTMaili API vastused kasutavad JSON-vormingut väljadega success, data ja error ning API-võtme kasutamisel ka usage. Cloudflare'i vead, sealhulgas sageduspiirangu vastused, võivad tagastada hoopis HTML-i. Enne JSON-i parsimist kontrollige HTTP olekut ja Content-Type'i.

  • Kui teate juba sellel saidil toetatud domeeni, pole vaja esmalt kutuda e-posti loomise lõimet. Saate kohapeal koostada prefix@domain ja otse kutsuda postkasti API-sid, säästes ühe API päringu.

Päringute sageduse piirangud ja korduskatsed

  • GET ja POST /api/generate-email jagavad ühist piirangut: 30 päringut 10 sekundi jooksul ühe lähte-IP-aadressi kohta. See kehtib nii avalikele kui ka isiklikele API-võtmetele. Sama IP-aadressi taga olevad erinevad võtmed ja kliendid jagavad seda piirangut.

  • Piirangu ületamisel tagastatakse HTTP 429 ja aadresside loomine blokeeritakse 10 sekundiks. Enne uuesti proovimist oodake Retry-After päises määratud aeg. Kui see päis puudub, oodake vähemalt 10 sekundit ja proovige seejärel uuesti järjest pikemate vahedega. Vältige sama IP-aadressi jagavate klientide samaaegseid korduskatseid.

  • See reegel ei kehti postkasti kirjade loetlemisele ega üksikute kirjade lugemisele. API-võtmete päevased ja kogukvoodid kehtivad endiselt eraldi. 10 sekundi ootamine ei taasta ammendatud võtmekvooti.

Põhilõimed

POST / GET
/api/generate-email

Loo ajutine postkast. Kasuta GET lihtsaima juhusliku voog jaoks või POST parameetritega prefix ja domain, kui soovid selget kontrolli.

GET
/api/emails?email=...

Too postkasti kirjad.

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

Too üks kiri, sealhulgas tekst, HTML, toore päised ja metaandmed.

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

Kustuta üks kiri ID järgi.

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

Kustuta kõik kirjad postkastis.

GET
/api/stats

Loe saidiüleseid statistikaid.

Näidisvoog

Allpool on kaks levinud mustrit: lase teenusel postkast luua või taotle kindel eesliide. Kui tead juba toetatud domeeni, saad postkasti kohapeal koostada ja otse päringuid teha.

1) Genereeri juhuslik ajutine e-posti aadress

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Vastuse näide
{
  "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) Genereeri fikseeritud eesliitega (nt 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"}'
Vastuse näide
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Kirjade loend postkastis

Kui teate juba toetatud domeeni, jätke samm 1 vahele ja päring tehke otse.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Vastuse näide
{
  "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) Loe üks kiri — sisaldab lihtteksti, HTML-sisu ja metaandmeid

Asendage EMAIL_ID 3. sammus tagastatud id-ga. Edastage ka postkasti aadress parameetrina email (ka kustutamisel ja manuste allalaadimisel): siis loetakse kiri otse tema postkastist, selle asemel et seda ID järgi otsida. API võtmega on parameeter email valikuline, kuid selle saatmine kiirendab otsingut.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Vastuse näide
{
  "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) Kustuta üks kiri ID järgi

API võtmega on parameeter email valikuline, kuid selle saatmine kiirendab otsingut.

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

6) Tühjenda kogu postkast — kustutab kõik kirjad selle aadressi jaoks

Iga päring kustutab ühe partii. Kuni vastuses on "has_more": true, kutsuge uuesti, kuni see tagastab false.

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

Vastuse struktuur

Edukad vastused näevad tavaliselt välja nii. Kui autentite API võtmega, pöörake tähelepanu kvooditeabele usage sees.

{
  "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
  }
}

Laiendatud statistika

  • /api/statistics/24h tagastab ühe 24-tunnise tunnijaotuse akna; kasutage offset=1,2,... varasemate akende kuvamiseks.
  • /api/statistics/top-subjects tagastab kõige sagedamad kirjade teemad.
  • /api/statistics/top-domains tagastab kõige aktiivsemad domeenid.
  • /api/statistics/top-senders tagastab kõige aktiivsemad saatjad.
GPTMail