Dukumiintiyada API

GPTMail API

Isticmaal GPTMail API si aad u abuurto sanduuqyo soo gal ku meel gaar ah, u liisgareyso oo u akhriso fariimaha, una tirtirto emaylka adigoo adeegsanaya HTTPS iyo madaxa X-API-Key. Wuxuu ku habboon yahay tijaabooyinka tooska ah, dhuumaha CI/CD iyo hababka shaqada ee QA.

Sida loo helo 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

Xulashada 2: Ku dar domain-kaaga

Marka domain dadweyne uu gudbo xaqiijinta MX: la gudbiyey adigoon gelin akoonka → furaha API (20000 codsi); la gudbiyey adigoo galay → 200 dhibcood. Domain kasta wuxuu helaa hal abaalmarin oo keliya. Muhiim ah: marka la xiriiro, suffix domain-ka wuxuu noqonayaa suffix dadweyne oo loogu talagalay dhammaan isticmaaleyaasha, sidaa dadka kale sidoo kale abuuri karaan cinwaanada sanduuqa hoostiisa. Kadib firfircoonida, ha tirtirin, ha beddelin, ha wax ka beddelin diiwaanka MX ee tilmaamaya domain-ka adeegga. Haddii kale, baaritaanka dambe wuxuu u arki karaa domain in aan sax ahayn. Haddii baaritaanku helo MX aan sax ahayn, domain waa la joojin doonaa. Haddii MX uu sii ahaado aan sax ahayn baaritaano 3 oo isku xiga, API Key la xiriira sidoo kale waa la joojin doonaa. Haddii MX mar kale noqdo sax, domain si toos ah ayaa dib loogu firfircoon doonaa.

Domainnada

Furaha tijaabada ee dadweynaha

Tijaabada, ku dir furaha dadweynaha ee la wadaago ee hoos ku muuqda madaxa X-API-Key. Wuu isbeddelaa maalin kasta, wuxuuna leeyahay xad maalinle ah oo ah 200,000 codsi oo ay wadaagaan dhammaan isticmaalayaashu.

Ka haray maanta

Dib u dejinaysa

Waxaa la soo dejinayaa qadarka furaha dadweynaha...

Tixraaca API ee hoose waxaa loo nuquli karaa sida Markdown qalabka AI, saldhigyada aqoonta, ama README.

URL-ka aasaasiga ah: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Bilow degdeg ah

  • X-API-Key: YOUR_KEY waa doorashada ugu fudud. Tijaabooyin degdeg ah, isticmaal furaha dadweynaha ee maalinlaha ah ee kor ku muuqda halkii aad ka isticmaali lahayd YOUR_KEY.

  • Inta badan meelaha sanduuqa waxay u baahan yihiin xuduudaha email, tusaale ?email=demo@example.com.

  • Jawaabaha GPTMail API waxay isticmaalaan JSON leh goobaha success, data iyo error, oo lagu daray usage marka fure API la isticmaalo. Khaladaadka Cloudflare, oo ay ku jiraan jawaabaha xadka heerka, waxay soo celin karaan HTML halkii JSON. Hubi xaaladda HTTP iyo Content-Type ka hor intaadan JSON falanqayn.

  • Haddii aad horey u taqaan domain la taageerayo boggan, uma baahnid inaad marka hore wacdo meesha abuurista email. Waxaad ku abuuri kartaa prefix@domain gudaha oo toos u wici kartaa API-yada sanduuqa, taas oo keydinaysa hal codsi API.

Xadka heerka codsiyada iyo isku dayga mar kale

  • GET iyo POST /api/generate-email waxay wadaagaan xad ah 30 codsi 10-kii ilbiriqsiba IP kasta oo isha ah. Tani waxay khusaysaa furayaasha API ee dadweynaha iyo kuwa shakhsiga ahba. Furayaal iyo macmiilo kala duwan oo ka dambeeya isla IP-ga ayaa wadaaga xadkan.

  • Ka gudbidda xadkan waxay soo celisaa HTTP 429 waxayna 10 ilbiriqsi xannibaysaa abuurista cinwaannada emaylka. Sug muddada Retry-After ka hor intaadan mar kale isku dayin. Haddii madaxani maqan yahay, sug ugu yaraan 10 ilbiriqsi, kadibna mar kale isku day adigoo sii kordhinaya muddada sugitaanka. Ka fogow isku dayo isku mar ah oo ka yimaada macmiilo wadaaga IP.

  • Xeerkani ma khuseeyo liisgareynta sanduuqa ama akhrinta emaylo gaar ah. Kootada maalinlaha ah iyo tan guud ee furayaasha API weli si gooni ah ayay u shaqeeyaan. Sugitaanka 10 ilbiriqsi ma soo celiso kootada fure dhammaatay.

Meelaha aasaasiga

POST / GET
/api/generate-email

Abuur sanduuq email ku meel ma ah. Isticmaal GET si fudud, ama POST oo leh prefix iyo domain markaad rabto xakamayn cad.

GET
/api/emails?email=...

Soo qaado emaylka sanduuqa.

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

Hel hal email, oo ay ku jira qoraal, HTML, cinwaanada asalka ah, iyo metadata.

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

Tirtir hal email adiga ID.

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

Tirtir dhammaan emaylka sanduuqa.

GET
/api/stats

Akhri tirakooyinka goobta oo dhan.

Tusaale socodka

Hoos waxaa jira laba qaab oo caadi ah: u oggolow adeegga inuu abuuro sanduuq, ama codso prefix la go'aamiyay. Haddii aad horey u taqaan domain la taageerayo hadda, waxaad sidoo kale ku abuuri kartaa sanduuq gudaha oo toos u weydiisan kartaa.

1) Abuur cinwaan email ku meel gaar ah oo nasiib ah

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Tusaale jawaab
{
  "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) Abuur oo leh prefix go'an (tusaale 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"}'
Tusaale jawaab
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Liiska emaylka sanduuqa

Haddii aad taqaan domain la taageerayo, ka bood tallaabo 1 oo toos u weydii.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Tusaale jawaab
{
  "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) Akhri hal email — waxaa ku jira qoraal cad, jirka HTML, iyo metadata

Ku beddel EMAIL_ID id-ga laga soo celiyay tallaabada 3. Sidoo kale u dir cinwaanka sanduuqa sida email (xitaa marka la tirtirayo ama lifaaqyada la soo dejinayo): emaylka waxaa markaas si toos ah looga akhriyaa sanduuqiisa halkii lagu raadin lahaa ID. Haddii aad haysato furaha API, halbeegga email waa ikhtiyaari, laakiin diristiisu waxay dedejisaa raadinta.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Tusaale jawaab
{
  "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) Tirtir hal email adiga ID

Haddii aad haysato furaha API, halbeegga email waa ikhtiyaari, laakiin diristiisu waxay dedejisaa raadinta.

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

6) Nadiifi sanduuqa oo dhan — tirtir dhammaan emaylka cinwaankan

Wac kasta wuxuu tirtiraa hal dufcad. Inta jawaabtu ka kooban tahay "has_more": true, mar kale wac ilaa ay soo celiso false.

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

Qaabka jawaabta

Jawaabaha guusha leh waxay caadi ahaan u egyihiin sidan. Haddii aad ku xaqiijiso API Key, fiiri macluumaadka xadka gudaha 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
  }
}

Tirakooyinka ballaaran

  • /api/statistics/24h wuxuu soo celiyaa hal daaqad oo 24 saacadood ah oo qaybinta saacad kasta ah; isticmaal offset=1,2,... daaqadaha hore.
  • /api/statistics/top-subjects wuxuu soo celiyaa mawduucyada emaylka ee ugu badan.
  • /api/statistics/top-domains soo celinta domain-yada ugu firfircoon.
  • /api/statistics/top-senders soo celinta kuwa diraya ugu firfircoon.
GPTMail