Nyaraka za API

API ya GPTMail

Tumia GPTMail API kuunda vikasha vya muda, kuorodhesha na kusoma ujumbe, na kufuta barua pepe kupitia HTTPS kwa kichwa cha X-API-Key. Inafaa kwa majaribio ya kiotomatiki, mifumo ya CI/CD na michakato ya QA.

Jinsi ya kupata 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

Chaguo 2: Ongeza kikoa chako mwenyewe

Baada ya kikoa cha umma kupita uthibitishaji wa MX: kilichowasilishwa bila kuingia → ufunguo wa API (maombi 20000); kilichowasilishwa ukiwa umeingia → pointi 200. Kila kikoa hupokea zawadi moja tu. Muhimu: mara tu kinapounganishwa, kiambishi cha kikoa hicho kinakuwa kiambishi cha umma kinachopatikana kwa watumiaji wote kwenye tovuti hii, hivyo watumiaji wengine wanaweza pia kutengeneza anwani za sanduku la barua chini yake. Baada ya kuamilishwa, usifute, usibadilishe, wala usihariri rekodi ya MX inayoelekeza kikoa hiki kwenye huduma yetu. Vinginevyo, ukaguzi wa baadaye unaweza kuona kikoa kimesanikwa vibaya. Ukaguzi ukikuta rekodi ya MX si halali, kikoa kitazimwa. Ikiwa rekodi ya MX inabaki si halali kwa ukaguzi 3 mfululizo, API Key inayohusiana pia itazimwa. Ikiwa rekodi ya MX inakuwa halali tena baadaye, kikoa kitaamilishwa upya kiotomatiki.

Vikoa

Ufunguo wa umma wa majaribio

Kwa majaribio, tuma ufunguo wa umma unaoshirikiwa ulioonyeshwa hapa chini katika kichwa cha X-API-Key. Hubadilika kila siku na una kikomo cha kila siku cha maombi 200,000 kinachoshirikiwa na watumiaji wote.

Kilichosalia leo

Inaweka upya baada ya

Inapakia quota ya moja kwa moja kwa ufunguo wa umma...

Rejea ya API hapa chini inaweza kunakiliwa kama Markdown kwa zana za AI, hifadhidata ya maarifa, au README.

URL ya msingi: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Anza haraka

  • X-API-Key: YOUR_KEY ndiyo njia rahisi zaidi. Kwa majaribio ya haraka, tumia ufunguo wa umma wa kila siku ulioonyeshwa hapo juu badala ya YOUR_KEY.

  • Endpoints nyingi za sanduku la barua zinahitaji kipengele email, kwa mfano ?email=demo@example.com.

  • Majibu ya GPTMail API hutumia JSON yenye sehemu za success, data na error, pamoja na usage ufunguo wa API unapotumika. Hitilafu za Cloudflare, zikiwemo majibu ya kikomo cha kasi, zinaweza kurudisha HTML badala yake. Kagua hali ya HTTP na Content-Type kabla ya kuchanganua JSON.

  • Ukishajua kikoa kinachotumika kwa sasa kwenye tovuti hii, huhitaji kuita endpoint ya kutengeneza barua pepe kwanza. Unaweza kuunda prefix@domain ndani ya kifaa na kuwaita API za sanduku la barua moja kwa moja, hivyo kuokoa ombi moja la API.

Vikomo vya kasi na majaribio upya

  • GET na POST /api/generate-email zinashiriki kikomo cha maombi 30 kwa kila sekunde 10 kwa kila IP chanzo. Hii inatumika kwa funguo za API za umma na binafsi. Funguo na programu tofauti zilizo nyuma ya IP moja hushiriki kikomo hiki.

  • Kuzidi kikomo hiki hurudisha HTTP 429 na huzuia uundaji wa anwani za barua pepe kwa sekunde 10. Subiri muda wa Retry-After kabla ya kujaribu tena. Ikiwa kichwa hiki hakipo, subiri angalau sekunde 10, kisha ujaribu tena kwa vipindi vinavyoongezeka. Epuka majaribio ya wakati mmoja kutoka kwa programu zinazoshiriki IP moja.

  • Kanuni hii haitumiki kwa kuorodhesha kikasha wala kusoma barua pepe moja moja. Viwango vya kila siku na vya jumla vya funguo za API bado vinatumika kivyake. Kusubiri sekunde 10 hakurejeshi kiwango cha ufunguo kilichokwisha.

Endpoints kuu

POST / GET
/api/generate-email

Tengeneza kikasha cha muda. Tumia GET kwa mtiririko rahisi wa sanduku la nasibu, au POST pamoja na prefix na domain unapotaka udhibiti wazi.

GET
/api/emails?email=...

Pata barua pepe za sanduku la barua.

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

Pata barua pepe moja, ikijumuisha maandishi, HTML, vichwa ghafi, na metadata.

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

Futa barua pepe moja kwa ID.

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

Futa barua pepe zote katika sanduku la barua.

GET
/api/stats

Soma takwimu za tovuti nzima.

Mfano wa mtiririko

Hapa chini kuna mifumo miwili ya kawaida: acha huduma itengenezee kikasha, au omba kiambishi kilichowekwa. Ukishajua kikoa kinachotumika kwa sasa, unaweza pia kuunda sanduku la barua ndani ya kifaa na kuuliza moja kwa moja.

1) Tengeneza anwani ya barua pepe ya muda ya nasibu

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Mfano wa majibu
{
  "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) Tengeneza na kiambishi kilichowekwa (mf. 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"}'
Mfano wa majibu
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Orodhesha barua pepe katika kikasha

Ukishajua kikoa kinachotumika, ruka hatua 1 na uliza moja kwa moja.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Mfano wa majibu
{
  "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) Soma barua pepe moja — inajumuisha maandishi ghafi, mwili wa HTML, na metadata

Badilisha EMAIL_ID kwa id iliyorudishwa katika hatua ya 3. Pia tuma anwani ya kikasha kama email (hata unapofuta au kupakua viambatisho): barua pepe husomwa moja kwa moja kutoka kwenye kikasha chake badala ya kutafutwa kwa ID. Ukiwa na ufunguo wa API, kigezo cha email ni cha hiari, lakini kukituma hufanya utafutaji uwe wa haraka zaidi.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Mfano wa majibu
{
  "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) Futa barua pepe moja kwa ID

Ukiwa na ufunguo wa API, kigezo cha email ni cha hiari, lakini kukituma hufanya utafutaji uwe wa haraka zaidi.

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

6) Safisha kikasha nzima — hufuta barua pepe zote kwa anwani hii

Kila mwito hufuta kundi moja. Maadamu jibu lina "has_more": true, uite tena hadi lirudishe false.

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

Muundo wa majibu

Majibu yenye mafanikio kwa kawaida yanaonekana hivi. Ukithibitisha kwa API Key, angalia taarifa ya quota ndani ya 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
  }
}

Takwimu zilizopanuliwa

  • /api/statistics/24h hurudisha dirisha moja la saa 24 la mgawanyo kwa saa; tumia offset=1,2,... kwa madirisha ya zamani zaidi.
  • /api/statistics/top-subjects inarudisha mada kuu za barua pepe.
  • /api/statistics/top-domains inarudisha vikoa vilivyotumika zaidi.
  • /api/statistics/top-senders inarudisha watumaji walio na shughuli zaidi.
GPTMail