Ìwé API

GPTMail API

Lo GPTMail API láti ṣẹ̀dá àwọn àpótí-ìwọlé ìgbà díẹ̀, ṣe àkójọ àti ka àwọn ìfiránṣẹ́, kí o sì pa ímeèlì rẹ́ nípasẹ̀ HTTPS pẹ̀lú àkọsórí X-API-Key. Ó bá àwọn ìdánwò aládàáṣe, àwọn ọ̀nà CI/CD àti iṣẹ́ QA mu.

Bí a ṣe le gba 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

Aṣayan 2: Fi domain rẹ kun

Lẹ́yìn tí domain gbogbo ènìyàn bá kọjá ìjẹ́rìísí MX: tí a fi ránṣẹ́ láì wọlé → kọ́kọ́rọ́ API (ìbéèrè 20000); tí a fi ránṣẹ́ nígbà tí a wọlé → àmì 200. Domain kọ̀ọ̀kan gba ẹ̀san kan ṣoṣo. Pataki: ni kete ti a ba so po, suffix ti domain naa di suffix ti gbogbo olumulo lori oju opo yii, nitorina awọn olumulo miiran tun le ṣẹda awọn adirẹsi apoti labẹ rẹ. Lẹhin ifijiṣẹ, ma pa, ma ṣatunṣe, tabi ṣatunkọ akọsilẹ MX ti n tọka domain si iṣẹ wa. Bibẹkọ, ayẹwo ti o bọ lẹhin le ka domain bi ti o ti ṣaṣẹ. Ti ayẹwo ba rii MX invalid, a yoo pa domain. Ti MX ba tẹsiwaju invalid ni ayẹwo 3 lẹyọn, API Key ti o ni ibatan yoo pa. Ti MX ba di valid lẹhin, a yoo tun mu domain ṣiṣẹ laifọwọyi.

Àwọn àgbègbè

Kọ́kọ́rọ́ gbogbogbò fún ìdánwò

Fún ìdánwò, fi kọ́kọ́rọ́ gbogbogbò tí a pín, tí a fihàn nísàlẹ̀, ránṣẹ́ nínú àkọsórí X-API-Key. Ó ń yípadà lójoojúmọ́, ó sì ní ààlà ojoojúmọ́ ti ìbéèrè 200,000 tí gbogbo olùlò ń pín.

Ti o ku loni

Tunṣe pada ni

Ngbe quota laif fọ bọtini ọdọ omo...

Aṣayan API ni isalẹ le daakọ bi Markdown fun awọn irinṣẹ AI, ipamọ imọ, tabi README.

URL ìpìlẹ̀: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Bẹrẹ yara

  • X-API-Key: YOUR_KEY ni àṣàyàn tó rọrùn jùlọ. Fún ìdánwò kíákíá, lo kọ́kọ́rọ́ gbogbogbò ojoojúmọ́ tí a fihàn lókè dípò YOUR_KEY.

  • Opọlọpọ awọn ipointi apoti nilo paramita email, fun apẹrẹ ?email=demo@example.com.

  • Àwọn ìdáhùn API GPTMail ń lo JSON pẹ̀lú àwọn pápá success, data àti error, pẹ̀lú usage nígbà tí a bá lo kọ́kọ́rọ́ API. Àwọn àṣìṣe Cloudflare, títí kan àwọn ìdáhùn ààlà iye ìbéèrè, lè dá HTML padà dípò rẹ̀. Ṣàyẹ̀wò ipò HTTP àti Content-Type kí o tó ka JSON.

  • Ti o ba ti mọ agbegbe ti a ṣe atilẹyin fun lori oju opo yii, o ko nilo lati pe endpoint ti ṣiṣẹda imeeli akọkọ. O le ṣẹda prefix@domain ni agbegbe ati pe API apoti taara, eyiti o fi ibeere API kan pamọ.

Ààlà iye ìbéèrè àti àtúngbìyànjú

  • GET àti POST /api/generate-email jọ ń pín ààlà ìbéèrè 30 ní gbogbo ìṣẹ́jú-àáyá 10 fún IP orísun kọ̀ọ̀kan. Èyí kan àwọn kọ́kọ́rọ́ API gbogbogbò àti ti ara ẹni. Àwọn kọ́kọ́rọ́ àti oníbàárà ọ̀tọ̀ọ̀tọ̀ tó ń lo IP kan náà jọ ń pín ààlà yìí.

  • Tí o bá kọjá ààlà yìí, a ó dá HTTP 429 padà, a ó sì dí ṣíṣẹ̀dá ímeèlì fún ìṣẹ́jú-àáyá 10. Dúró fún àkókò tí Retry-After sọ kí o tó tún gbìyànjú. Tí àkọlé HTTP yìí kò bá sí, dúró fún ó kéré tán ìṣẹ́jú-àáyá 10, lẹ́yìn náà tún gbìyànjú pẹ̀lú ìdádúró tó ń pọ̀ sí i. Yẹra fún àtúngbìyànjú ní àkókò kan náà láti ọ̀dọ̀ àwọn oníbàárà tó ń pín IP kan.

  • Òfin yìí kò kan ṣíṣe àtòjọ àpótí-ìwọlé tàbí kíkà ímeèlì kọ̀ọ̀kan. Ìpín ojoojúmọ́ àti àpapọ̀ ìpín ti kọ́kọ́rọ́ API ṣì ń ṣiṣẹ́ lọ́tọ̀. Dídúró fún ìṣẹ́jú-àáyá 10 kò dá ìpín kọ́kọ́rọ́ tí ó ti tán padà.

Awọn ipointi ipilẹṣẹ

POST / GET
/api/generate-email

Ṣẹda apoti-imeeli akoko kan. Lo GET fun ilana apoti ti o rọrun julọ, tabi POST pẹlu prefix ati domain nigba ti o ba fẹ iṣakoso ti o han.

GET
/api/emails?email=...

Mu awọn imeeli fun apoti-imeeli.

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

Mu imeeli kan, pẹlu ọrọ, HTML, awọn akọsilẹ, ati metadata.

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

Pa imeeli kan rẹ nipasẹ ID.

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

Pa gbogbo awọn imeeli ninu apoti naa.

GET
/api/stats

Ka awọn iṣiro agbegbe gbogbo oju opo wẹẹbu naa.

Apẹrẹ isipopada

Nisalẹ ni awọn ilana meji ti o wọpọ: jẹ iṣẹ ṣẹda apoti, tabi beere prefix ti a fi sọtọ. Ti o ba ti mọ agbegbe ti a ṣe atilẹyin fun ni isisiyi, o tun le ṣẹda apoti ni agbegbe ati beere taara.

1) Ṣẹda adirẹsi imeeli akoko ti o ṣẹlẹ

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Apẹrẹ esi
{
  "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) Ṣẹda pẹlu prefix ti a fi sọtọ (bii 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"}'
Apẹrẹ esi
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Akojọ awọn imeeli ninu apoti

Ti o ba ti mọ agbegbe ti a ṣe atilẹyin fun, fo igbẹsẹ 1 ki o beere taara.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Apẹrẹ esi
{
  "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) Ka imeeli kan — pẹlu ọrọ ti o han, ara HTML, ati metadata

Rọ́pò EMAIL_ID pẹ̀lú id tí ìgbésẹ̀ 3 dá padà. Tún fi àdírẹ́sì àpótí-ìwọlé ránṣẹ́ gẹ́gẹ́ bí email (fún pípa rẹ́ àti gbígba àsomọ́ wálẹ̀ pẹ̀lú): nígbà náà a ó ka ímeèlì náà tààrà láti inú àpótí-ìwọlé rẹ̀ dípò wíwá a pẹ̀lú ID. Pẹ̀lú kọ́kọ́rọ́ API, paramita email kò pọn dandan, ṣùgbọ́n fífi í ránṣẹ́ máa ń mú kí ìwádìí yára.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Apẹrẹ esi
{
  "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) Pa imeeli kan nipasẹ ID

Pẹ̀lú kọ́kọ́rọ́ API, paramita email kò pọn dandan, ṣùgbọ́n fífi í ránṣẹ́ máa ń mú kí ìwádìí yára.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Apẹrẹ esi
{
  "success": true,
  "data": {
    "message": "Email deleted"
  }
}

6) Pa gbogbo apoti — pa gbogbo awọn imeeli fun adirẹsi yii

Ìpè kọ̀ọ̀kan máa ń pa ìdìpọ̀ kan rẹ́. Níwọ̀n ìgbà tí ìdáhùn bá ní "has_more": true, pè é lẹ́ẹ̀kan sí i títí yóò fi dá false padà.

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

Awọ esi

Awọn esi aṣeyọri ni o wa dabi eyi. Ti o ba fi idanimọ han pẹlu API Key, ṣe akiyesi alaye quota ninu 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
  }
}

Awọn iṣiro ti a fi gun

  • /api/statistics/24h ń dá fèrèsé ìpínkiri wákàtí 24 kan padà; lo offset=1,2,... fún àwọn fèrèsé àtijọ́.
  • /api/statistics/top-subjects ń dá àwọn àkọlé ímeèlì tó léwájú padà.
  • /api/statistics/top-domains ń dá àwọn àgbègbè tó ń ṣiṣẹ́ jùlọ padà.
  • /api/statistics/top-senders ń dá àwọn olùfiránṣẹ́ tó ń ṣiṣẹ́ jùlọ padà.
GPTMail