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.

  • Повеќето endpoint-и на сандачето бараат параметар email, на пример ?email=demo@example.com.

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

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

Ограничувања на брзината на барања и повторни обиди

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

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

  • Ова правило не важи за прикажување на листата во сандачето ниту за читање поединечни пораки. Дневните и вкупните квоти на API клучевите и понатаму важат независно. Чекањето од 10 секунди не ја враќа потрошената квота на клучот.

Основни endpoint-и

POST / GET
/api/generate-email

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

GET
/api/emails?email=...

Преземи 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 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