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 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.

  • Већина крајњих тачака за сандучиће захтева параметар email, на пример ?email=demo@example.com.

  • Одговори GPTMail API-ја користе JSON са пољима success, data и error, као и usage када се користи API кључ. Cloudflare грешке, укључујући одговоре о ограничењу учесталости захтева, уместо тога могу вратити HTML. Проверите HTTP статус и Content-Type пре парсирања JSON-а.

  • Ако већ знате домен који сајт тренутно подржава, не морате прво да позивате крајњу тачку за генерисање е-поште. Можете локално да саставите prefix@domain и директно позовете API-је за сандучиће, чиме штедите један API захтев.

Ограничења учесталости захтева и поновни покушаји

  • GET и POST /api/generate-email деле ограничење од 30 захтева на 10 секунди по изворној IP адреси. Ово важи и за јавне и за личне API кључеве. Различити кључеви и клијенти иза исте IP адресе деле ово ограничење.

  • Прекорачење овог ограничења враћа HTTP 429 и блокира генерисање адреса на 10 секунди. Пре новог покушаја сачекајте онолико колико наводи Retry-After. Ако то заглавље недостаје, сачекајте најмање 10 секунди, а затим покушајте поново са све дужим паузама. Избегавајте истовремене поновне покушаје са клијената који деле IP адресу.

  • Ово правило не важи за листање сандучета нити за читање појединачних порука. Дневне и укупне квоте API кључа и даље важе независно. Чекање од 10 секунди не враћа исцрпљену квоту кључа.

Основне крајње тачке

POST / GET
/api/generate-email

Генеришите привремени сандучић. Користите GET за најједноставнији насумични ток или POST са prefix и domain када желите експлицитну контролу.

GET
/api/emails?email=...

Преузми поруке за сандуче.

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

Преузми један email, укључујући текст, HTML, сирова заглавља и метаподатке.

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

Обриши једну поруку по ID-у.

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

Обриши све поруке у сандучету.

GET
/api/stats

Читај статистику целог сајта.

Пример тока

Испод су два уобичајена обрасца: нека сервис генерише сандучић за вас или затражите фиксни префикс. Ако већ знате подржан домен, можете адресу саставити локално и директно је упитати.

1) Генеришите насумичну привремену email адресу

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) Листа email порука у сандучићу

Ако већ знате подржан домен, прескочите корак 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 кључем, обратите пажњу на податке о квоти унутар 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