API Inyandiko

GPTMail API

Koresha API ya GPTMail kugira ngo ukore udusanduku tw'ubutumwa tw'agateganyo, urebe urutonde rw'ubutumwa, ubusome kandi usibe imeri ukoresheje HTTPS n'umutwe (header) wa X-API-Key. Ibereye amagerageza yikora, imiyoboro ya CI/CD n'imirimo ya QA.

Uko wakira 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

Amahitamo 2: Ongeraho domain yawe

Nyuma y'uko indangarubuga rusange yemejwe na MX: yatanzwe utarinjiye muri konti → urufunguzo rwa API (ubusabe 20000); yatanzwe winjiye → amanota 200. Buri ndangarubuga ihabwa igihembo kimwe gusa. Birenzeho: iyo bihuje, suffix ya domain iraba suffix y'abantu bose kuri uyu murongo, bityo abandi bakoresha bashobora gukora aderesi z'amasanduku hepfo yayo. Nyuma yo gukora, ntukoreshe, ntuhindure, cyangwa ntugenzura inyandiko ya MX ierekana domain ku serivisi yacu. Bitandukanye, isuzuma riri kuruhande rushobora kubona domain itari neza. Niba isuzuma ribona MX itari yo, domain izahagarikwa. Niba MX ikomeza kutari yo mu 3 zikurikirana, na API Key ihuye nayo izahagarikwa. Niba MX igaruka kuba yo, domain izongera gukorwa ku gitondo.

Indangarubuga

Urufunguzo rusange rwo kugerageza

Mu igerageza, ohereza urufunguzo rusange rusangiwe rugaragara hepfo mu mutwe wa X-API-Key. Ruhinduka buri munsi kandi rufite umupaka wa buri munsi w'ibisabwa 200,000 abakoresha bose basangiye.

Byasigaye uyumunsi

Bisubiramo nyuma ya

Gushyiraho quota y'ubu ku urufunguzo rw'abantu bose...

Ibyerekeye API hepfo urashobora kubikopera nk'Markdown ku bikoresho bya AI, ububiko bw'amakuru, cyangwa README.

URL y'ibanze: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Tangira vuba

  • X-API-Key: YOUR_KEY ni bwo buryo bworoshye kurusha ubundi. Ku magerageza yihuse, koresha urufunguzo rusange rwa buri munsi rugaragara hejuru mu mwanya wa YOUR_KEY.

  • Inzira nyinshi z'agasanduku zikeneye impinga email, urugero ?email=demo@example.com.

  • Ibisubizo bya API ya GPTMail bikoresha JSON irimo success, data na error, hakiyongeraho usage iyo hakoreshejwe urufunguzo rwa API. Amakosa ya Cloudflare, harimo ibisubizo by'umupaka w'ibisabwa, ashobora gusubiza HTML. Banza ugenzure imiterere ya HTTP na Content-Type mbere yo gusesengura JSON.

  • Niba uzi domain yemewe ubu kuri uru rubuga, ntugomba kubanza guhamagara inzira yo gukora email. Urashobora gukora prefix@domain ku buryo bwawe ukahamagara API z'agasanduku butaziguye, bigaragaza ubusabe bw'API bumwe.

Umuvuduko ntarengwa w'ibisabwa no kongera kugerageza

  • GET na POST /api/generate-email bisangira umupaka w'ibisabwa 30 mu masegonda 10 kuri buri IP y'inkomoko. Ibi bireba imfunguzo za API rusange n'iz'umuntu ku giti cye. Imfunguzo n'abakiriya batandukanye bakoresha IP imwe basangira uyu mupaka.

  • Kurenga uyu mupaka bisubiza HTTP 429 kandi bigahagarika gukora aderesi za imeri mu masegonda 10. Tegereza igihe cyanditswe muri Retry-After mbere yo kongera kugerageza. Iyo uwo mutwe udahari, tegereza nibura amasegonda 10, hanyuma wongere kugerageza ugenda wongera igihe cyo gutegereza. Irinde ko abakiriya basangiye IP bongera kugerageza icyarimwe.

  • Iri tegeko ntirireba kugaragaza urutonde rw'agasanduku k'ubutumwa cyangwa gusoma imeri imwe imwe. Imipaka ya buri munsi n'iya rusange y'imfunguzo za API ikomeza gukurikizwa ukwayo. Gutegereza amasegonda 10 ntibisubizaho umupaka w'urufunguzo wamaze gukoreshwa wose.

Inzira nkuru z'API

POST / GET
/api/generate-email

Kora agasanduku k'iminota. Koresha GET ku buryo bworoshye, cyangwa POST hamwe na prefix na domain iyo ushaka gucunga burumvikanye.

GET
/api/emails?email=...

Shakisha ubutumwa bw'email mu gasanduku.

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

Shakisha email imwe, harimo ubutumwa, HTML, intambwe z'umwimerere, na metadata.

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

Siba email imwe ukoresheje ID.

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

Siba ubutumwa bwose mu gasanduku.

GET
/api/stats

Soma ibarura by'urubuga rwose.

Urugero rw'inzira

Hasi hariho inzira ebyiri zikunze: reka serivisi ikore agasanduku, cyangwa saba prefix yashyizweho. Niba uzi domain yemewe ubu, urashobora gukora agasanduku ku buryo bwawe ukabaza butaziguye.

1) Kora aderesi ya email y'igihe gito itunguranye

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Urugero rw'igisubizo
{
  "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) Kora ufite prefix yashyizweho (urugero 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"}'
Urugero rw'igisubizo
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Urutonde rw'amabaruwa mu gasanduku

Niba uzi domain yemewe, simbuka intambwe 1 ukabaza butaziguye.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Urugero rw'igisubizo
{
  "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) Soma email imwe — harimo ubutumwa butaziguye, umubiri wa HTML, na metadata

Simbuza EMAIL_ID id yagarutse mu ntambwe ya 3. Ohereza kandi aderesi y'agasanduku k'ubutumwa nka email (no mu gusiba no gukuraho imigereka): bityo imeri isomwa ako kanya mu gasanduku kayo aho gushakishwa hakoreshejwe ID. Ufite urufunguzo rwa API, ikigenderwaho email si ngombwa, ariko kucyohereza bituma gushakisha byihuta.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Urugero rw'igisubizo
{
  "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) Siba email imwe ukoresheje ID

Ufite urufunguzo rwa API, ikigenderwaho email si ngombwa, ariko kucyohereza bituma gushakisha byihuta.

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

6) Sibamo agasanduku kose — siba amabaruwa yose kuri iyi aderesi

Buri hamagara risiba icyiciro kimwe. Igihe cyose igisubizo kirimo "has_more": true, ongera uhamagare kugeza igaruye false.

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

Imiterere y'igisubizo

Igisubizo cyiza gikunze kuba nk'iki. Niba wemeza na API Key, reba amakuru ya quota muri 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
  }
}

Ibarura ziyongewe

  • /api/statistics/24h isubiza idirishya rimwe ry'ikwirakwizwa ku isaha ry'amasaha 24; koresha offset=1,2,... ku madirishya ya kera.
  • /api/statistics/top-subjects isubiza insanganyamatsiko z'imeri zikunze kugaragara.
  • /api/statistics/top-domains garuza domain zikoreshwa cyane.
  • /api/statistics/top-senders garuza abohereza bakoresha cyane.
GPTMail