API sənədləri

GPTMail API

GPTMail API ilə X-API-Key başlığından istifadə edərək HTTPS üzərindən müvəqqəti gələnlər qutuları yaradın, məktubları siyahılayın və oxuyun, həmçinin poçtu silin. Avtomatlaşdırılmış testlər, CI/CD konveyerləri və QA iş axınları üçün uyğundur.

API Key necə alınır

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

Seçim 2: Öz domeninizi əlavə edin

İctimai domen MX yoxlamasından keçdikdən sonra: hesaba daxil olmadan təqdim edilibsə → API açarı (20000 sorğu); hesaba daxil olaraq təqdim edilibsə → 200 xal. Hər domen yalnız bir mükafat alır. Vacibdir: qoşulduqdan sonra həmin domenin sonluğu bu saytdakı bütün istifadəçilər üçün ictimai sonluq olur, başqaları da altında poçt ünvanı yarada bilər. Aktivasiyadan sonra domeni xidmətimizə yönləndirən MX qeydini silməyin, əvəz etməyin və ya dəyişdirməyin. Əks halda sonrakı yoxlamalar domeni səhv konfiqurasiya saya bilər. Sonrakı yoxlama MX-i etibarsız tapsa, domen deaktiv olunur. MX 3 ardıcıl yoxlamada etibarsız qalarsa, bağlı API Key də deaktiv olunur. MX sonra yenidən etibarlı olsa, domen avtomatik yenidən aktivləşir.

Domenlər

İctimai test açarı

Test üçün aşağıda göstərilən ortaq ictimai açarı X-API-Key başlığında göndərin. Açar hər gün dəyişir və bütün istifadəçilər arasında bölüşdürülən gündəlik 200 000 sorğu limitinə malikdir.

Bu gün qalan

Sıfırlanır

İctimai açar üçün canlı kvota yüklənir...

Aşağıdakı API istinadını AI alətləri, bilik bazaları və ya README üçün Markdown kimi kopyalaya bilərsiniz.

Əsas URL: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Sürətli başlanğıc

  • X-API-Key: YOUR_KEY ən sadə seçimdir. Sürətli testlər üçün YOUR_KEY əvəzinə yuxarıda göstərilən gündəlik ictimai açardan istifadə edin.

  • Çox poçt qutusu endpoint-i email parametri tələb edir, məsələn ?email=demo@example.com.

  • GPTMail API cavabları success, data və error sahələri olan JSON formatındadır; API açarı istifadə edildikdə usage sahəsi də əlavə olunur. Cloudflare xətaları, o cümlədən sorğu limiti cavabları, bunun əvəzinə HTML qaytara bilər. JSON-u emal etməzdən əvvəl HTTP statusunu və Content-Type başlığını yoxlayın.

  • Bu saytda dəstəklənən domeni artıq bilirsinizsə, əvvəlcə məktub yaratma endpoint-inə ehtiyac yoxdur. Lokal olaraq prefix@domain qurub poçt API-lərini birbaşa çağırın — bir API request qənaət edir.

Sorğu limitləri və təkrar cəhdlər

  • GET və POST /api/generate-email hər mənbə IP ünvanı üçün 10 saniyədə 30 sorğuluq ortaq limitə malikdir. Bu, həm ictimai, həm də şəxsi API açarlarına aiddir. Eyni IP arxasındakı müxtəlif açarlar və müştəri proqramları bu limiti bölüşür.

  • Bu limit aşıldıqda HTTP 429 qaytarılır və e-poçt yaradılması 10 saniyə müddətinə bloklanır. Təkrar cəhd etməzdən əvvəl Retry-After müddətini gözləyin. Bu başlıq yoxdursa, ən azı 10 saniyə gözləyin, sonra artan fasilələrlə təkrar cəhd edin. Eyni IP ünvanını bölüşən müştəri proqramlarından eyni vaxtda təkrar cəhdlərə yol verməyin.

  • Bu qayda gələnlər qutusunun siyahılanmasına və ayrı-ayrı məktubların oxunmasına aid deyil. API açarının gündəlik və ümumi kvotaları bundan asılı olmayaraq tətbiq olunmağa davam edir. 10 saniyə gözləmək tükənmiş açar kvotasını bərpa etmir.

Əsas endpointlər

POST / GET
/api/generate-email

Müvəqqəti poçt qutusu yaradın. Ən sadə təsadüfi axın üçün GET istifadə edin və ya açıq nəzarət istədikdə prefix və domain ilə POST.

GET
/api/emails?email=...

Poçt qutusu üçün məktubları gətirin.

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

Tək məktubu gətirin: mətn, HTML, xam başlıqlar və metadata daxil olmaqla.

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

ID ilə bir məktubu silin.

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

Poçt qutusundakı bütün məktubları silin.

GET
/api/stats

Bütün sayt statistikasını oxuyun.

Nümunə axını

Aşağıda iki üsul var: xidmətin sizin üçün qutu yaratmasına icazə verin və ya sabit prefiks istəyin. Artıq dəstəklənən domeni bilirsinizsə, ünvanı lokal qurub birbaşa sorğuya da bilərsiniz.

1) Təsadüfi müvəqqəti e-poçt ünvanı yaradın

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Cavab nümunəsi
{
  "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) Sabit prefikslə yaradın (məs. 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"}'
Cavab nümunəsi
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Poçt qutusundakı məktubları siyahıla

Dəstəklənən domeni bilirsinizsə, 1-ci addımı atlayın və birbaşa sorğulayın.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Cavab nümunəsi
{
  "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) Tək məktubu oxuyun — düz mətn, HTML gövdə və metadata daxil olmaqla

EMAIL_ID-ni 3-cü addımda qaytarılan id ilə əvəz edin. Gələnlər qutusunun ünvanını da email kimi ötürün (silmə və qoşma yükləmələri üçün də): bu halda məktub ID üzrə axtarılmır, birbaşa öz gələnlər qutusundan oxunur. API açarı ilə email parametri isteğe bağlıdır, lakin onu göndərmək axtarışı sürətləndirir.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Cavab nümunəsi
{
  "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 ilə bir məktubu silin

API açarı ilə email parametri isteğe bağlıdır, lakin onu göndərmək axtarışı sürətləndirir.

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

6) Bütün qutunu təmizləyin — bu ünvan üçün bütün məktubları silir

Hər çağırış bir partiyanı silir. Cavabda "has_more": true olduğu müddətcə, false qaytarana qədər yenidən çağırın.

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

Cavabın forması

Uğurlu cavablar adətən belə görünür. API Key ilə autentifikasiya edərkən usage içindəki kvotaya diqqət yetirin.

{
  "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
  }
}

Genişləndirilmiş statistika

  • /api/statistics/24h saatlar üzrə paylanmanın bir 24 saatlıq pəncərəsini qaytarır; daha köhnə pəncərələr üçün offset=1,2,... istifadə edin.
  • /api/statistics/top-subjects ən çox rast gəlinən məktub mövzularını qaytarır.
  • /api/statistics/top-domains ən aktiv domenləri qaytarır.
  • /api/statistics/top-senders ən aktiv göndəriciləri qaytarır.
GPTMail