Dokumentazzjoni API

GPTMail API

Uża l-API ta' GPTMail biex tiġġenera inboxes temporanji, telenka u taqra l-messaġġi, u tħassar l-emails permezz ta' HTTPS b'header X-API-Key. Hija soluzzjoni adattata għal testijiet awtomatizzati, pipelines CI/CD u flussi tax-xogħol tal-QA.

Kif tikseb 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

Għażla 2: Żid id-domein tiegħek

Wara li dominju pubbliku jgħaddi mill-verifika MX: mibgħut mingħajr ma tidħol → ċavetta API (20000 talba); mibgħut meta tkun dħalt → 200 punt. Kull dominju jirċievi premju wieħed biss. Importanti: ladarba tkun konness, dak is-suffiss tad-domein isir suffiss pubbliku għall-utenti kollha fuq dan is-sit, għalhekk utenti oħra jistgħu wkoll iġġeneraw indirizzi ta' kaxxa taħtu. Wara l-attivazzjoni, tħassarx, tibdlix u timmodifikax ir-rekord MX li jippuntja dan id-domein lejn is-servizz tagħna. Inkella, iċ-ċekkjar aktar tard jistgħu jqisu d-domein mhux konfigurat sew. Jekk ċekkjar aktar tard isib ir-rekord MX invalidu, id-domein jiġi diżattivat. Jekk ir-rekord MX jibqa' invalidu għal 3 ċekkjar konsekuttivi, l-API Key assoċjata tiġi diżattivata wkoll. Jekk ir-rekord MX jerġa' jkun validu aktar tard, id-domein jiġi riattivat awtomatikament.

Dominji

Ċavetta pubblika għall-ittestjar

Għall-ittestjar, ibgħat iċ-ċavetta pubblika komuni murija hawn taħt fil-header X-API-Key. Tinbidel kuljum u għandha limitu ta' kuljum ta' 200,000 talba, maqsum bejn l-utenti kollha.

Fadal illum

Jerġa' jissetja fi

Qed jitgħabba l-kwota live għall-muftieħ pubbliku...

Ir-referenza API hawn taħt tista' tiġi kkupjata bħala Markdown għal għodod AI, bażijiet ta' għarfien jew README.

URL bażi: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Bidu malajr

  • X-API-Key: YOUR_KEY hija l-aktar għażla sempliċi. Għal testijiet malajr, uża ċ-ċavetta pubblika ta' kuljum murija hawn fuq minflok YOUR_KEY.

  • Il-biċċa l-kbira tal-punti tal-aħħar tal-kaxxa jeħtieġu parametru email, per eżempju ?email=demo@example.com.

  • It-tweġibiet tal-API ta' GPTMail jużaw JSON bil-qasam success, data u error, flimkien ma' usage meta tintuża ċavetta API. L-iżbalji ta' Cloudflare, inklużi t-tweġibiet minħabba l-limitu tal-frekwenza, jistgħu jirritornaw HTML minflok. Iċċekkja l-istatus HTTP u l-Content-Type qabel ma tanalizza l-JSON.

  • Jekk diġà taf domein appoġġjat fuq dan is-sit, m'għandekx bżonn iċċempel l-ewwel lill-punt tal-ġenerazzjoni tal-email. Tista' tikkomponi prefix@domain lokali u tċempel direttament lill-API tal-kaxxa, li tiffranka API request waħda.

Limiti tal-frekwenza u tentattivi mill-ġdid

  • GET u POST /api/generate-email jaqsmu limitu ta' 30 talba kull 10 sekondi għal kull indirizz IP tas-sors. Dan japplika kemm għaċ-ċwievet API pubbliċi kif ukoll għal dawk personali. Ċwievet u klijenti differenti wara l-istess IP jaqsmu dan il-limitu.

  • Jekk taqbeż dan il-limitu, tirċievi HTTP 429 u l-ġenerazzjoni tal-indirizzi tiġi mblukkata għal 10 sekondi. Stenna d-durata indikata minn Retry-After qabel ma terġa' tipprova. Jekk dan l-header ma jkunx preżenti, stenna mill-inqas 10 sekondi, imbagħad erġa' pprova b'intervalli dejjem itwal. Evita tentattivi simultanji minn klijenti li jaqsmu l-istess IP.

  • Din ir-regola ma tapplikax għall-elenkar tal-messaġġi f'inbox jew għall-qari ta' emails individwali. Il-kwoti ta' kuljum u totali taċ-ċwievet API xorta japplikaw b'mod indipendenti. Li tistenna 10 sekondi ma jirrestawrax kwota ta' ċavetta li tkun spiċċat.

Punti ewlenin tal-aħħar

POST / GET
/api/generate-email

Iġġenera kaxxa temporanja. Uża GET għall-flixxu l-aktar sempliċi ta' kaxxa każwali, jew POST b'prefix u domain meta trid kontroll espliċitu.

GET
/api/emails?email=...

Iġbor l-email għal kaxxa postali.

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

Iġbor email waħda, inkluż test, HTML, headers mhux ipproċessati u metadata.

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

Ħassar email waħda skont ID.

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

Ħassar l-email kollha f'kaxxa postali.

GET
/api/stats

Aqra l-istatistiki tal-sit kollu.

Eżempju ta' fluss

Hawn taħt żewġ mudelli komuni: ħalli s-servizz iġġenera kaxxa għalik, jew itlob prefiss fiss. Jekk diġà taf domein appoġġjat bħalissa, tista' wkoll tikkomponi l-kaxxa lokali u tistaqsiha direttament.

1) Iġġenera indirizz email temporanju każwali

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Eżempju ta' rispons
{
  "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) Iġġenera b'prefiss fiss (eż. 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"}'
Eżempju ta' rispons
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Lista l-email f'kaxxa

Jekk taf domein appoġġjat, aqbeż il-pass 1 u staqsi direttament.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Eżempju ta' rispons
{
  "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) Aqra email waħda — inkluż test sempliċi, korp HTML u metadata

Ibdel EMAIL_ID b'id li jirritorna l-pass 3. Għaddi wkoll l-indirizz tal-inbox bħala email (anke għat-tħassir u għat-tniżżil tal-annessi): b'hekk l-email tinqara direttament mill-inbox tagħha minflok ma tiġi mfittxija bl-ID. B'API key il-parametru email huwa fakultattiv, iżda jekk tibagħtu t-tfittxija ssir aktar malajr.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Eżempju ta' rispons
{
  "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) Ħassar email waħda skont ID

B'API key il-parametru email huwa fakultattiv, iżda jekk tibagħtu t-tfittxija ssir aktar malajr.

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

6) Ivvojta kaxxa sħiħa — tħassar l-email kollha għal dan l-indirizz

Kull sejħa tħassar lott wieħed. Sakemm it-tweġiba jkun fiha "has_more": true, erġa' sejjaħ sakemm tirritorna false.

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

Forma tar-rispons

Ir-risposti ta' suċċess normalment jidhru hekk. Jekk tawtentika b'API Key, osserva l-informazzjoni tal-kwota ġewwa 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
  }
}

Istatistiki estiżi

  • /api/statistics/24h jirritorna tieqa waħda ta' 24 siegħa b'distribuzzjoni skont is-siegħa; uża offset=1,2,... għal twieqi eqdem.
  • /api/statistics/top-subjects jirritorna l-aktar suġġetti komuni tal-emails.
  • /api/statistics/top-domains jirritorna l-aktar domeini attivi.
  • /api/statistics/top-senders jirritorna l-aktar mittenti attivi.
GPTMail