API dokumentacija

GPTMail API

Pomoću GPTMail API-ja možete stvarati privremene pretince, popisivati i čitati poruke te brisati poštu putem HTTPS-a uz zaglavlje X-API-Key. Prikladan je za automatizirane testove, CI/CD cjevovode i QA procese.

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

Opcija 2: Dodajte vlastitu domenu

Nakon uspješne MX provjere javne domene: poslano bez prijave → API ključ (20000 zahtjeva); poslano uz prijavu → 200 bodova. Svaka domena dobiva samo jednu nagradu. Važno: nakon povezivanja taj sufiks domene postaje javni sufiks dostupan svim korisnicima, pa i drugi mogu generirati adrese pretinca pod njim. Nakon aktivacije ne brišite, ne zamjenjujte niti mijenjajte MX zapis koji usmjerava domenu na našu uslugu. Inače kasnije provjere mogu smatrati domenu pogrešno konfiguriranom. Ako provjera utvrdi nevažeći MX zapis, domena će biti deaktivirana. Ako MX zapis ostane nevažećim tijekom 3 uzastopnih provjera, povezani API Key također će biti deaktiviran. Ako MX zapis ponovo postane važećim, domena će se automatski ponovno aktivirati.

Domene

Javni ključ za testiranje

Za testiranje pošaljite zajednički javni ključ prikazan u nastavku u zaglavlju X-API-Key. Mijenja se svaki dan i ima dnevno ograničenje od 200.000 zahtjeva koje dijele svi korisnici.

Preostalo danas

Reset za

Učitavanje trenutačne kvote za javni ključ...

API referencu u nastavku možete kopirati kao Markdown za AI alate, baze znanja ili README.

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

AI
llms.txt

·

llms-full.txt

(Markdown)

Brzi početak

  • X-API-Key: YOUR_KEY najjednostavnija je opcija. Za brze testove umjesto YOUR_KEY upotrijebite dnevni javni ključ prikazan iznad.

  • Većina endpointa pretinca zahtijeva parametar email, primjerice ?email=demo@example.com.

  • Odgovori GPTMail API-ja koriste JSON s poljima success, data i error, uz polje usage kada se koristi API ključ. Pogreške Cloudflarea, uključujući odgovore zbog ograničenja brzine, umjesto toga mogu vratiti HTML. Prije parsiranja JSON-a provjerite HTTP status i Content-Type.

  • Ako već znate podržanu domenu na ovom web-mjestu, ne morate prvo pozivati endpoint generiranja email. Možete lokalno sastaviti prefix@domain i izravno pozvati API pretinca, što štedi jedan API zahtjev.

Ograničenja brzine i ponovni pokušaji

  • GET i POST /api/generate-email dijele ograničenje od 30 zahtjeva u 10 sekundi po izvornoj IP adresi. To vrijedi i za javne i za osobne API ključeve. Različiti ključevi i klijenti iza iste IP adrese dijele to ograničenje.

  • Prekoračenje ovog ograničenja vraća HTTP 429 i na 10 sekundi blokira stvaranje adresa e-pošte. Prije ponovnog pokušaja pričekajte onoliko koliko navodi Retry-After. Ako tog zaglavlja nema, pričekajte najmanje 10 sekundi, a zatim pokušavajte ponovno s postupno duljim razmacima. Izbjegavajte istodobne ponovne pokušaje klijenata koji dijele IP adresu.

  • Ovo se pravilo ne odnosi na popis poruka u pretincu ni na čitanje pojedinačnih e-poruka. Dnevne i ukupne kvote API ključa i dalje se primjenjuju neovisno o njemu. Čekanje od 10 sekundi ne obnavlja iscrpljenu kvotu ključa.

Glavni endpointi

POST / GET
/api/generate-email

Generirajte privremeni pretinac. Koristite GET za najjednostavniji slučajni tok ili POST s prefix i domain kada želite izričitu kontrolu.

GET
/api/emails?email=...

Dohvatite poruke e-pošte za pretinac.

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

Dohvatite jednu poruku, uključujući tekst, HTML, sirove zaglavlja i metapodatke.

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

Izbrišite jednu poruku prema ID-u.

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

Izbrišite sve poruke u pretincu.

GET
/api/stats

Čitajte statistiku cijele stranice.

Primjer tijeka

Ispod su dva uobičajena obrasca: neka usluga generira pretinac za vas ili zatražite fiksni prefiks. Ako već znate podržanu domenu, možete adresu sastaviti lokalno i izravno je upitati.

1) Generirajte slučajnu privremenu email adresu

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

3) Popis poruka u pretincu

Ako već znate podržanu domenu, preskočite korak 1 i upitajte izravno.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Primjer odgovora
{
  "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) Pročitajte jednu poruku — uključuje plain text, HTML tijelo i metapodatke

Zamijenite EMAIL_ID id-om vraćenim u koraku 3. Proslijedite i adresu pretinca kao email (i pri brisanju i preuzimanju priloga): poruka se tada čita izravno iz njezina pretinca umjesto da se traži po ID-u. S API ključem parametar email nije obavezan, ali njegovo slanje ubrzava pretraživanje.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Primjer odgovora
{
  "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šite jednu poruku prema ID-u

S API ključem parametar email nije obavezan, ali njegovo slanje ubrzava pretraživanje.

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

6) Ispraznite cijeli pretinac — briše sve poruke za tu adresu

Svaki poziv briše jednu skupinu. Dok odgovor sadrži "has_more": true, pozivajte ponovno dok ne vrati false.

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

Oblik odgovora

Uspješni odgovori obično izgledaju ovako. Ako se autentificirate API Keyem, obratite pažnju na informacije o kvoti unutar 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
  }
}

Proširena statistika

  • /api/statistics/24h vraća raspodjelu po satima za jedno 24-satno razdoblje; parametrom offset=1,2,... dohvaćate starija razdoblja.
  • /api/statistics/top-subjects vraća najčešće predmete e-poruka.
  • /api/statistics/top-domains vraća najaktivnije domene.
  • /api/statistics/top-senders vraća najaktivnije pošiljatelje.
GPTMail