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 բանալին։ Եթե 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։ JSON-ը վերլուծելուց առաջ ստուգեք HTTP կարգավիճակը և Content-Type-ը։

  • Եթե արդեն գիտեք այս կայքում ներկայումս աջակցվող տիրույթ, պետք չէ նախ կանչել նամակի գեներացման վերջնակետը։ Կարող եք տեղում կազմել 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=...

Բերեք մեկ նամակ՝ ներառյալ տեքստը, 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 բանալիով, ուշադրություն դարձրեք 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