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 жооптору 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