Документация на API

GPTMail API

Използвайте API на GPTMail, за да създавате временни пощенски кутии, да преглеждате и четете съобщения и да изтривате поща през 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=...

Изтрива едно email по ID.

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

Изтрива всички 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