API-dokumentado

GPTMail API

Uzu la API de GPTMail por krei provizorajn enirkestojn, listigi kaj legi mesaĝojn kaj forigi retpoŝton per HTTPS kun la kaplinio X-API-Key. Ĝi taŭgas por aŭtomataj testoj, CI/CD-duktoj kaj QA-laborfluoj.

Kiel akiri 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

Opcio 2: Aldonu vian propran domajnon

Post sukcesa MX-kontrolo de publika domajno: sendita sen ensaluto → API-ŝlosilo (20000 petoj); sendita dum ensaluto → 200 poentoj. Ĉiu domajno ricevas nur unu rekompencon. Grava: post konekto tiu domajna sufikso iĝas publika sufikso por ĉiuj uzantoj ĉi tie, do aliaj uzantoj ankaŭ povas generi ricevujadresojn sub ĝi. Post aktivigo ne forigu, anstataŭigu nek modifu la MX-registron, kiu direktas ĉi tiun domajnon al nia servo. Alie postaj kontroloj povas konsideri la domajnon misagordita. Se posta kontrolo trovas la MX-registron nevalida, la domajno malaktiviĝos. Se la MX-registro restas nevalida dum 3 sinsekvaj kontroloj, ankaŭ la rilata API Key malaktiviĝos. Se la MX-registro poste denove validas, la domajno reaktiviĝos aŭtomate.

Domajnoj

Publika testa ŝlosilo

Por testado, sendu la komunan publikan ŝlosilon montritan sube en la kaplinio X-API-Key. Ĝi ŝanĝiĝas ĉiutage kaj havas tagan limon de 200 000 petoj, kiun dividas ĉiuj uzantoj.

Restas hodiaŭ

Restarigas post

Ŝargas vivan kvoton por la publika ŝlosilo...

La suba API-referenco povas esti kopiita kiel Markdown por AI-iloj, sciobazoj aŭ README.

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

AI
llms.txt

·

llms-full.txt

(Markdown)

Rapida starto

  • X-API-Key: YOUR_KEY estas la plej simpla elekto. Por rapidaj testoj, uzu la tagan publikan ŝlosilon montritan supre anstataŭ YOUR_KEY.

  • Plej multaj ricevujaj finpunktoj postulas parametron email, ekzemple ?email=demo@example.com.

  • La respondoj de la GPTMail-API uzas JSON kun la kampoj success, data kaj error, kaj ankaŭ usage, kiam API-ŝlosilo estas uzata. Eraroj de Cloudflare, inkluzive de respondoj pri petofrekvenca limo, povas anstataŭe redoni HTML. Kontrolu la HTTP-staton kaj Content-Type antaŭ ol analizi JSON.

  • Se vi jam scias nuntempe subtenatan domajnon ĉi tie, vi ne devas unue voki la generadan finpunkton. Vi povas lokale kunmeti prefix@domain kaj rekte voki la ricevujajn APIjn, kio ŝparas unu API request.

Limoj de petofrekvenco kaj reprovoj

  • GET kaj POST /api/generate-email kunhavas limon de 30 petoj po 10 sekundoj por ĉiu fonta IP. Tio validas por publikaj kaj personaj API-ŝlosiloj. Malsamaj ŝlosiloj kaj klientoj malantaŭ la sama IP kunhavas ĉi tiun limon.

  • Superi ĉi tiun limon redonas HTTP 429 kaj blokas la kreadon de adresoj dum 10 sekundoj. Atendu la daŭron indikitan de Retry-After antaŭ ol reprovi. Se tiu kaplinio mankas, atendu almenaŭ 10 sekundojn kaj poste reprovu kun kreskantaj paŭzoj. Evitu samtempajn reprovojn de klientoj, kiuj kunhavas IP-adreson.

  • Ĉi tiu regulo ne validas por listigo de enirkesto aŭ legado de unuopaj retmesaĝoj. Tagaj kaj tutaj kvotoj de API-ŝlosiloj daŭre validas sendepende. Atendi 10 sekundojn ne restarigas elĉerpitan ŝlosilan kvoton.

Ĉefaj finpunktoj

POST / GET
/api/generate-email

Generu portempan ricevujon. Uzu GET por la plej simpla hazarda fluo, aŭ POST kun prefix kaj domain kiam vi volas eksplicitan kontrolon.

GET
/api/emails?email=...

Alportu retpoŝtojn por ricevujo.

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

Alportu unu retpoŝton, inkluzive tekston, HTML, krudajn kapojn kaj metadatumojn.

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

Forigu unu retpoŝton laŭ ID.

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

Forigu ĉiujn retpoŝtojn en ricevujo.

GET
/api/stats

Legu tutretejajn statistikojn.

Ekzemplo de fluo

Sube estas du oftaj modeloj: lasu la servon generi ricevujon por vi, aŭ petu fiksan prefikson. Se vi jam scias nuntempe subtenatan domajnon, vi ankaŭ povas lokale kunmeti la ricevujon kaj rekte peti ĝin.

1) Generi hazardan portempan retpoŝtadreson

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Ekzemplo de respondo
{
  "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) Generi kun fiksa prefikso (ekz. 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"}'
Ekzemplo de respondo
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Listigi retpoŝtojn en ricevujo

Se vi jam scias subtenatan domajnon, preterpasu paŝon 1 kaj rekte petu.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Ekzemplo de respondo
{
  "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) Legi unu retpoŝton — inkluzive platan tekston, HTML-korpon kaj metadatumojn

Anstataŭigu EMAIL_ID per id redonita en paŝo 3. Sendu ankaŭ la adreson de la enirkesto kiel email (ankaŭ por forigoj kaj elŝutoj de kunsendaĵoj): tiam la retmesaĝo estas legata rekte el sia enirkesto anstataŭ esti serĉata laŭ ID. Kun API-ŝlosilo la parametro email estas nedeviga, sed sendi ĝin rapidigas la serĉon.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Ekzemplo de respondo
{
  "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) Forigi unu retpoŝton laŭ ID

Kun API-ŝlosilo la parametro email estas nedeviga, sed sendi ĝin rapidigas la serĉon.

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

6) Malplenigi tutan ricevujon — forigas ĉiujn retpoŝtojn por ĉi tiu adreso

Ĉiu voko forigas unu aron. Dum la respondo enhavas "has_more": true, voku ĝin denove ĝis ĝi redonas false.

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

Formo de respondo

Sukcesaj respondoj kutime aspektas tiel. Se vi aŭtentigas per API Key, atentu la kvotinformon en 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
  }
}

Etenditaj statistikoj

  • /api/statistics/24h redonas unu 24-horan fenestron de hora distribuo; uzu offset=1,2,... por pli malnovaj fenestroj.
  • /api/statistics/top-subjects redonas la plej oftajn retpoŝtajn temojn.
  • /api/statistics/top-domains redonas la plej aktivajn domajnojn.
  • /api/statistics/top-senders redonas la plej aktivajn sendintojn.
GPTMail