API dokumentacija

GPTMail API

Z API-jem GPTMail lahko prek HTTPS z glavo X-API-Key ustvarjate začasne nabiralnike, izpisujete in berete sporočila ter brišete pošto. Primeren je za avtomatizirane teste, cevovode CI/CD in delovne tokove QA.

Kako pridobiti 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

Možnost 2: Dodajte lastno domeno

Po uspešnem preverjanju MX javne domene: oddano brez prijave → ključ API (20000 zahtevkov); oddano po prijavi → 200 točk. Vsaka domena prejme le eno nagrado. Pomembno: po povezavi ta pripona domene postane javna in na voljo vsem uporabnikom, zato lahko tudi drugi ustvarjajo naslove nabiralnikov pod njo. Po aktivaciji ne brišite, ne zamenjujte in ne spreminjajte MX zapisa, ki usmerja domeno na našo storitev. Sicer lahko kasnejše preverjanje domeno obravnava kot napačno nastavljeno. Če preverjanje ugotovi neveljaven MX zapis, bo domena deaktivirana. Če MX zapis ostane neveljaven pri 3 zaporednih preverjanjih, bo povezani API Key prav tako deaktiviran. Če MX zapis pozneje spet postane veljaven, bo domena samodejno znova aktivirana.

Domene

Javni testni ključ

Za testiranje v glavi X-API-Key pošljite skupni javni ključ, prikazan spodaj. Ključ se zamenja vsak dan in ima dnevno omejitev 200.000 zahtev, ki si jo delijo vsi uporabniki.

Preostalo danes

Ponastavitev čez

Nalaganje trenutne kvote za javni ključ...

API referenco spodaj lahko kopirate kot Markdown za AI orodja, baze znanja ali README.

Osnovni naslov URL: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Hiter začetek

  • X-API-Key: YOUR_KEY je najenostavnejša možnost. Za hitre teste namesto YOUR_KEY uporabite dnevni javni ključ, prikazan zgoraj.

  • Večina končnih točk nabiralnika zahteva parameter email, npr. ?email=demo@example.com.

  • Odgovori API GPTMail uporabljajo JSON s polji success, data in error, pri uporabi API ključa pa še s poljem usage. Napake Cloudflare, vključno z odgovori ob preseženi omejitvi števila zahtev, lahko namesto tega vrnejo HTML. Pred razčlenjevanjem JSON preverite stanje HTTP in Content-Type.

  • Če že poznate podprto domeno na tej strani, vam ni treba najprej klicati končne točke za generiranje email. Lokalno lahko sestavite prefix@domain in neposredno kličete API nabiralnika, kar prihrani en API zahtevek.

Omejitve števila zahtev in ponovni poskusi

  • GET in POST /api/generate-email si delita omejitev 30 zahtev na 10 sekund za posamezen izvorni naslov IP. To velja za javne in osebne API ključe. Različni ključi in odjemalci za istim naslovom IP si to omejitev delijo.

  • Prekoračitev te omejitve vrne HTTP 429 in za 10 sekund blokira ustvarjanje e-poštnih naslovov. Pred ponovnim poskusom počakajte toliko časa, kot navaja Retry-After. Če ta glava manjka, počakajte vsaj 10 sekund in nato poskusite znova s čedalje daljšimi zamiki. Izogibajte se hkratnim ponovnim poskusom odjemalcev, ki si delijo naslov IP.

  • To pravilo ne velja za izpis nabiralnika ali branje posameznih sporočil. Dnevne in skupne kvote API ključev kljub temu veljajo neodvisno. Čakanje 10 sekund ne obnovi izčrpane kvote ključa.

Jedrne končne točke

POST / GET
/api/generate-email

Ustvarite začasen nabiralnik. Uporabite GET za najenostavnejši naključni tok ali POST s prefix in domain, ko želite ekspliciten nadzor.

GET
/api/emails?email=...

Pridobi sporočila e-pošte za nabiralnik.

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

Pridobi eno sporočilo, vključno z besedilom, HTML, surovimi glavami in metapodatki.

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

Izbriši eno sporočilo po ID.

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

Izbriši vsa sporočila v nabiralniku.

GET
/api/stats

Preberi statistiko celotne strani.

Primer poteka

Spodaj sta dva pogosta vzorca: naj storitev ustvari nabiralnik za vas ali zahtevajte fiksno predpono. Če že poznate podprto domeno, lahko naslov sestavite lokalno in jo neposredno poizvedete.

1) Ustvari naključen začasen email naslov

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Primer odziva
{
  "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) Ustvari s fiksno predpono (npr. 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"}'
Primer odziva
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Seznam sporočil v nabiralniku

Če že poznate podprto domeno, preskočite korak 1 in poizvedite neposredno.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Primer odziva
{
  "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) Preberi eno sporočilo — vključuje plain text, HTML telo in metapodatke

EMAIL_ID zamenjajte z id-jem, ki ga je vrnil korak 3. Naslov nabiralnika podajte tudi kot email (tudi pri brisanju in prenosu prilog): sporočilo se tako prebere neposredno iz njegovega nabiralnika, namesto da bi se iskalo po ID-ju. S ključem API je parameter email neobvezen, vendar njegovo pošiljanje pospeši iskanje.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Primer odziva
{
  "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) Izbriši eno sporočilo po ID

S ključem API je parameter email neobvezen, vendar njegovo pošiljanje pospeši iskanje.

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

6) Počisti cel nabiralnik — izbriše vsa sporočila za ta naslov

Vsak klic izbriše en paket. Dokler odgovor vsebuje "has_more": true, ga kličite znova, dokler ne vrne false.

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

Oblika odziva

Uspešni odzivi običajno izgledajo takole. Če se overite z API Key, bodite pozorni na informacije o kvoti znotraj 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
  }
}

Razširjena statistika

  • /api/statistics/24h vrne eno 24-urno okno urne porazdelitve; za starejša okna uporabite offset=1,2,... v poizvedbi.
  • /api/statistics/top-subjects vrne najpogostejše zadeve e-sporočil.
  • /api/statistics/top-domains vrne najbolj aktivne domene.
  • /api/statistics/top-senders vrne najbolj aktivne pošiljatelje.
GPTMail