د API اسناد

GPTMail API

د GPTMail API په مرسته د HTTPS له لارې او د X-API-Key سرلیک سره لنډمهاله ان باکسونه جوړ کړئ، پیغامونه لېست کړئ او ولولئ، او برېښنالیکونه ړنګ کړئ. دا د اتومات ازموینو، CI/CD پایپ لاینونو او QA کاري بهیرونو لپاره مناسب دی.

څنګه 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

اختیار 2: خپل ډومین اضافه کړئ

د عامه ډومین د MX تایید وروسته: له ننوتلو پرته سپارل شوی → د API کیلي (20000 غوښتنې)؛ د ننوتلو پر مهال سپارل شوی → 200 نمرې. هر ډومین یوازې یوه جایزه ترلاسه کوي. مهم: له نښلولو وروسته، د هغه ډومین وروستاړی په یو عامه وروستاړي بدلېږي چې د دې سایټ ټولو کاروونکو ته شتون لري، نو نور کاروونکي هم کولی شي د هغه لاندې د پوست بکس پتې جوړې کړي. له فعالېدو وروسته، هغه MX ریکارډ مه ړنګوئ، مه بدلوئ او مه سموئ چې دا ډومین زموږ خدمت ته اړوي. که نه، وروستۍ ازموینې کېدای شي ډومین ناسم تنظیم شوی وګڼي. که وروسته ازموینه MX ریکارډ ناسم ومومي، ډومین غیرفعالېږي. که MX ریکارډ په 3 پرله پسې ازموینو کې ناسم پاتې شي، اړونده API کیلي هم غیرفعالېږي. که MX ریکارډ وروسته بیا سم شي، ډومین په اتومات ډول بیا فعالېږي.

ډومینونه

د ازموینې عامه کیلي

د ازموینې لپاره، لاندې ښودل شوې ګډه عامه کیلي د X-API-Key سرلیک کې ولېږئ. دا هره ورځ بدلېږي او د 200,000 غوښتنو ورځنی حد لري چې ټول کاروونکي یې په ګډه کاروي.

نن پاتې

تر بیا پیل پورې

د عامه key لپاره ژوندی کوټا بار کیږي...

لاندې API مرجع د AI وسیلو، پوهې زېرمې یا README لپاره د Markdown په توګه کاپي کیدی شي.

بنسټیز URL: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

ګړندی پیل

  • X-API-Key: YOUR_KEY تر ټولو ساده لاره ده. د چټکو ازموینو لپاره، د YOUR_KEY پر ځای پورته ښودل شوې ورځنۍ عامه کیلي وکاروئ.

  • د پوست بکس ډېری پای ټکي email پارامیټر ته اړتیا لري، د بېلګې په توګه ?email=demo@example.com.

  • د GPTMail API ځوابونه JSON کاروي چې success، data او error فیلډونه لري، او کله چې API کیلي وکارول شي usage هم پکې وي. د Cloudflare تېروتنې، په شمول د غوښتنو د کچې د حد ځوابونو، کېدای شي پر ځای یې HTML راوګرځوي. د JSON له تحلیل مخکې د HTTP حالت او Content-Type وګورئ.

  • که تاسو پدې سایټ کې یو اوسنی ملاتړ شوی ډومین پېژنئ، اړتیا نشته چې لومړی د برېښنالیک جوړولو پای ټکی وغواړئ. تاسو کولی شئ prefix@domain په محلي ډول جوړ کړئ او مستقیم د پوست بکس API ګانې وغواړئ، چې یوه API غوښتنه سپموي.

د غوښتنو حدونه او بیا هڅې

  • GET او POST /api/generate-email د هرې سرچینې IP لپاره په 10 ثانیو کې د 30 غوښتنو ګډ حد لري. دا پر عامه او شخصي دواړو API کیلي پلي کېږي. هغه بېلابېلې کیلي او کلاینټونه چې د یو IP تر شا دي، دا حد په ګډه کاروي.

  • له دې حد څخه تېرېدل HTTP 429 راګرځوي او د برېښنالیک جوړول د 10 ثانیو لپاره بندوي. له بیا هڅې مخکې د Retry-After موده انتظار وکړئ. که دا سرلیک نه وي، لږ تر لږه 10 ثانیې انتظار وکړئ، بیا د زیاتېدونکو ځنډونو سره بیا هڅه وکړئ. د هغو کلاینټونو له همزمانو بیا هڅو ډډه وکړئ چې یو IP په ګډه کاروي.

  • دا قاعده د ان باکس پر لېست کولو یا د جلا برېښنالیکونو پر لوستلو نه پلي کېږي. د API کیلي ورځنۍ او ټولې کوټې لا هم په خپلواک ډول پلي کېږي. د 10 ثانیو انتظار د پای ته رسېدلې کیلي کوټه بېرته نه راګرځوي.

اصلي API پای ټکي

POST / GET
/api/generate-email

لنډمهاله ان باکس جوړ کړئ. د تر ټولو ساده تصادفي ان باکس لپاره GET وکاروئ، یا کله چې څرګند کنټرول غواړئ، POST د prefix او domain سره وکاروئ.

GET
/api/emails?email=...

د یو پوست بکس برېښنالیکونه راوړئ.

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

یو برېښنالیک راوړئ، په شمول د متن، HTML، خامو سرلیکونو او میټاډېټا.

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

یو برېښنالیک د ID له مخې ړنګ کړئ.

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

د یو پوست بکس ټول برېښنالیکونه ړنګ کړئ.

GET
/api/stats

د ټولې سایټ احصایې ولولئ.

د مثال جریان

لاندې دوه عامې بېلګې دي: خدمت ته اجازه ورکړئ چې ستاسو لپاره ان باکس جوړ کړي، یا یو ثابت مختاړی وغواړئ. که تاسو دمخه یو اوسنی ملاتړ شوی ډومین پېژنئ، کولی شئ پوست بکس په محلي ډول جوړ کړئ او مستقیم یې وپوښتئ.

1) تصادفي لنډمهاله برېښنالیک پته جوړه کړئ

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
د ځواب مثال
{
  "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) د ثابت prefix سره جوړ کړئ (لکه 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"}'
د ځواب مثال
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) د ان باکس برېښنالیکونه لېست کړئ

که ملاتړ شوی ډومین پوهیږئ نو ګام 1 پرېږدئ او مستقیم پوښتنه وکړئ.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
د ځواب مثال
{
  "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) یو برېښنالیک ولولئ — ساده متن، د HTML متن او میټاډېټا پکې شامل دي

EMAIL_ID د هغه id سره بدل کړئ چې په 3 ګام کې راستون شوی. د ان باکس پته هم د email په توګه ولېږئ (د ړنګولو او د ضمیمو د ښکته کولو لپاره هم): بیا برېښنالیک د ID له مخې د لټولو پر ځای مستقیم له خپل ان باکس څخه لوستل کېږي. د API کیلي سره email پارامیټر اختیاري دی، خو لېږل یې لټون چټک کوي.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
د ځواب مثال
{
  "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) یو برېښنالیک د ID له مخې ړنګ کړئ

د API کیلي سره email پارامیټر اختیاري دی، خو لېږل یې لټون چټک کوي.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
د ځواب مثال
{
  "success": true,
  "data": {
    "message": "Email deleted"
  }
}

6) ټول ان باکس پاک کړئ — د دې پتې ټول برېښنالیکونه ړنګوي

هره غوښتنه یوه ډله ړنګوي. تر هغه چې ځواب "has_more": true ولري، بیا یې وغواړئ تر څو false راوګرځوي.

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

د ځواب بڼه

بریالي ځوابونه عموما داسې ښکاري. که تاسو د API key سره تصدیق وکړئ نو په 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
  }
}

پراخې احصایې

  • /api/statistics/24h د 24 ساعتونو یوه ساعتواره وېش کړکۍ راګرځوي؛ د زړو کړکیو لپاره offset=1,2,... وکاروئ.
  • /api/statistics/top-subjects د برېښنالیکونو تر ټولو عامې موضوعګانې راګرځوي.
  • /api/statistics/top-domains ترټولو فعال ډومینونه بیرته راوړي.
  • /api/statistics/top-senders ترټولو فعال لیږونکي بیرته راوړي.
GPTMail