API құжаттамасы

GPTMail API

GPTMail API арқылы X-API-Key тақырыбымен HTTPS бойынша уақытша пошта жәшіктерін жасап, хаттардың тізімін алып, оларды оқи және жоя аласыз. Ол автоматтандырылған тесттерге, 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 Key де өшіріледі. MX кейін қайта жарамды болса, домен автоматты түрде қайта қосылады.

Домендер

Тестілеуге арналған жария кілт

Тестілеу үшін төменде көрсетілген ортақ жария кілтті X-API-Key тақырыбында жіберіңіз. Ол күн сайын ауысады және барлық пайдаланушыларға ортақ күндік 200 000 сұраныс лимиті бар.

Бүгін қалғаны

Қайта орнатылады

Жария кілт үшін тікелей квота жүктелуде...

Төмендегі API анықтамасын Markdown түрінде AI құралдары, білім базалары немесе README үшін көшіруге болады.

Негізгі URL: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Жылдам бастау

  • X-API-Key: YOUR_KEY — ең қарапайым нұсқа. Жылдам тесттер үшін YOUR_KEY орнына жоғарыда көрсетілген күндік жария кілтті пайдаланыңыз.

  • Көп жәшік endpoint-тері email параметрін талап етеді, мысалы ?email=demo@example.com.

  • GPTMail API жауаптары success, data және error өрістері бар JSON-ды, ал API кілті пайдаланылса, қосымша usage өрісін қолданады. Cloudflare қателері, соның ішінде сұраныс жиілігі шегінің жауаптары, оның орнына HTML қайтаруы мүмкін. JSON-ды талдамас бұрын HTTP күйі мен Content-Type мәнін тексеріңіз.

  • Осы сайтта қолдау көрсетілетін доменді білсеңіз, алдымен хат жасау endpoint-ін шақыру қажет емес. prefix@domain жергілікті түрде құрып жәшік API-лерін тікелей шақырыңыз — бір API request үнемдейсіз.

Сұраныс жиілігінің шектеулері және қайталау

  • GET және POST /api/generate-email бір бастапқы IP үшін 10 секундта 30 сұраныс шегін ортақ пайдаланады. Бұл жария және жеке API кілттеріне де қолданылады. Бір IP артындағы әртүрлі кілттер мен клиенттер осы шекті ортақ пайдаланады.

  • Бұл шектен асқанда HTTP 429 қайтарылады және мекенжай жасау 10 секундқа бұғатталады. Қайталамас бұрын Retry-After ұзақтығын күтіңіз. Бұл тақырып болмаса, кемінде 10 секунд күтіп, кейін аралықты біртіндеп ұзарта отырып қайталаңыз. Бір IP-ді бөлісетін клиенттерден бір мезгілде қайталаудан аулақ болыңыз.

  • Бұл ереже пошта жәшігінің тізімін алуға немесе жеке хаттарды оқуға қолданылмайды. API кілттерінің күндік және жалпы квоталары бөлек қолданыла береді. 10 секунд күту таусылған кілт квотасын қалпына келтірмейді.

Негізгі endpointтер

POST / GET
/api/generate-email

Уақытша жәшік жасаңыз. Ең қарапайым кездейсоқ ағын үшін GET қолданыңыз немесе нақты басқару керек болса prefix және domain бар POST.

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) Бекітілген префикспен жасау (мыс. 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 мәнін 3-қадамда қайтарылған id-мен ауыстырыңыз. Сондай-ақ пошта жәшігінің мекенжайын 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