API-dokumentaatio

GPTMail API

GPTMail API:n avulla voit luoda väliaikaisia postilaatikoita, listata ja lukea viestejä sekä poistaa sähköposteja HTTPS:n kautta X-API-Key-otsakkeella. Se sopii automaattisiin testeihin, CI/CD-putkiin ja QA-työnkulkuihin.

API Keyn hankkiminen

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

Vaihtoehto 2: Lisää oma verkkotunnus

Kun julkisen verkkotunnuksen MX-tarkistus onnistuu: lähetetty kirjautumatta → API-avain (20000 pyyntöä); lähetetty kirjautuneena → 200 pistettä. Kukin verkkotunnus saa vain yhden palkinnon. Tärkeää: yhdistämisen jälkeen verkkotunnuksen suffiksi on julkinen kaikille käyttäjille, joten muut voivat myös luoda osoitteita sen alle. Aktivoinnin jälkeen älä poista, vaihda tai muokkaa MX-tietuetta, joka osoittaa verkkotunnuksen palveluumme — muuten myöhemmät tarkistukset voivat tulkita asetukset virheellisiksi. Jos MX todetaan virheelliseksi, verkkotunnus poistetaan käytöstä. Jos MX pysyy virheellisenä 3 peräkkäisessä tarkistuksessa, myös liitetty API Key poistetaan käytöstä. Kun MX on taas kelvollinen, verkkotunnus aktivoidaan automaattisesti uudelleen.

Verkkotunnukset

Julkinen testiavain

Testausta varten lähetä alla näkyvä jaettu julkinen avain X-API-Key-otsakkeessa. Avain vaihtuu päivittäin, ja sillä on kaikkien käyttäjien kesken jaettu 200 000 pyynnön päiväraja.

Jäljellä tänään

Nollautuu

Ladataan julkisen avaimen live-kiintiötä...

Alla oleva API-viite voidaan kopioida Markdownina AI-työkaluihin, tietopankkeihin tai README-tiedostoon.

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

AI
llms.txt

·

llms-full.txt

(Markdown)

Pika-aloitus

  • X-API-Key: YOUR_KEY on yksinkertaisin vaihtoehto. Pikatesteissä käytä yllä näkyvää päivittäistä julkista avainta YOUR_KEY:n tilalla.

  • Useimmat postilaatikko-endpointit vaativat parametrin email, esim. ?email=demo@example.com.

  • GPTMail API:n vastaukset käyttävät JSON-muotoa, jossa on kentät success, data ja error sekä usage, kun käytetään API-avainta. Cloudflaren virheet, myös nopeusrajoitusvastaukset, voivat palauttaa sen sijaan HTML:ää. Tarkista HTTP-tila ja Content-Type ennen JSONin jäsentämistä.

  • Jos tunnet jo tuetun verkkotunnuksen, sinun ei tarvitse ensin kutsua osoitteen generointi-endpointia. Voit koostaa prefix@domain paikallisesti ja kutsua postilaatikko-API:ita suoraan — säästät yhden pyynnön.

Nopeusrajoitukset ja uudelleenyritykset

  • GET ja POST /api/generate-email jakavat 30 pyynnön rajan 10 sekunnin jaksoa kohden lähde-IP-osoitetta kohti. Tämä koskee sekä julkisia että henkilökohtaisia API-avaimia. Saman IP-osoitteen takana olevat eri avaimet ja asiakasohjelmat jakavat tämän rajan.

  • Rajan ylittäminen palauttaa HTTP 429 -vastauksen ja estää osoitteiden luonnin 10 sekunniksi. Odota Retry-After-otsakkeen ilmoittama aika ennen uutta yritystä. Jos otsaketta ei ole, odota vähintään 10 sekuntia ja yritä sitten uudelleen kasvavin viivein. Vältä samanaikaisia uudelleenyrityksiä asiakasohjelmilta, jotka jakavat saman IP-osoitteen.

  • Tämä sääntö ei koske postilaatikon listausta eikä yksittäisten viestien lukemista. API-avainten päivittäiset ja kokonaiskiintiöt ovat edelleen voimassa erikseen. 10 sekunnin odotus ei palauta loppuun käytettyä avaimen kiintiötä.

Päätepisteet

POST / GET
/api/generate-email

Luo väliaikainen postilaatikko. Käytä GET yksinkertaisimpaan satunnaiseen virtaan tai POST kentillä prefix ja domain, kun haluat täyden hallinnan.

GET
/api/emails?email=...

Hae sähköpostit postilaatikkoon.

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

Hae yksi viesti: teksti, HTML, raakat headerit ja metatiedot.

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

Poista yksi viesti ID:llä.

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

Poista kaikki viestit postilaatikosta.

GET
/api/stats

Lue koko sivuston tilastot.

Esimerkkivirta

Alla kaksi yleistä tapaa: anna palvelun luoda postilaatikko tai pyydä kiinteä etuliite. Jos tunnet jo tuetun verkkotunnuksen, voit myös koostaa osoitteen paikallisesti ja kysyä suoraan.

1) Luo satunnainen väliaikainen sähköpostiosoite

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Vastauksen esimerkki
{
  "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) Luo kiinteällä etuliitteellä (esim. 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"}'
Vastauksen esimerkki
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Listaa viestit postilaatikossa

Jos tunnet jo tuetun verkkotunnuksen, ohita vaihe 1 ja kysy suoraan.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Vastauksen esimerkki
{
  "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) Lue yksi viesti — mukana pelkkä teksti, HTML-runko ja metatiedot

Korvaa EMAIL_ID vaiheessa 3 palautetulla id:llä. Välitä myös postilaatikon osoite email-parametrina (myös poistoissa ja liitteiden latauksissa): silloin viesti luetaan suoraan sen postilaatikosta sen sijaan, että sitä haettaisiin ID:n perusteella. API-avaimen kanssa email-parametri on valinnainen, mutta sen lähettäminen nopeuttaa hakua.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Vastauksen esimerkki
{
  "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) Poista yksi viesti ID:llä

API-avaimen kanssa email-parametri on valinnainen, mutta sen lähettäminen nopeuttaa hakua.

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

6) Tyhjennä koko postilaatikko — poistaa kaikki viestit tälle osoitteelle

Jokainen kutsu poistaa yhden erän. Niin kauan kuin vastauksessa on "has_more": true, kutsu uudelleen, kunnes se palauttaa false.

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

Vastauksen rakenne

Onnistuneet vastaukset näyttävät yleensä tältä. API Keyllä — kiinnitä huomiota kiintiötietoihin kentässä 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
  }
}

Laajennetut tilastot

  • /api/statistics/24h palauttaa yhden 24 tunnin tuntijakaumaikkunan; käytä offset=1,2,... vanhemmille ikkunoille.
  • /api/statistics/top-subjects palauttaa yleisimmät viestien aiheet.
  • /api/statistics/top-domains palauttaa aktiivisimmat verkkotunnukset.
  • /api/statistics/top-senders palauttaa aktiivisimmat lähettäjät.
GPTMail