Belgekirina API

GPTMail API

API-ya GPTMail bikar bînin da ku bi rêya HTTPS û bi sernivîsa X-API-Key qutiyên e-nameyan ên demkî çêbikin, peyaman rêz bikin û bixwînin, û e-nameyan jê bibin. Ew ji bo ceribandinên otomatîk, xetên CI/CD û pêvajoyên QA guncan e.

Çawa API Key bistîne

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

Vebijêrk 2: Domaina xwe zêde bike

Piştî ku domaina giştî piştrastkirina MX derbas dike: bê têketin hatiye şandin → mifteya API (20000 daxwaz); bi têketin hatiye şandin → 200 xal. Her domain tenê yek xelatê distîne. Girîng: piştî girêdanê wê paşgira domainê dibe paşgirek giştî ji bo hemû bikarhênerên vê malperê, bikarhênerên din jî dikarin li bin wê navnîşanên nameyê çêkin. Piştî çalakkirinê, tomara MX ya ku vê domainê ber bi servîsa me ve nîşan dide jê nebe, ne were guhartin an sererastkirin. Wê paşê kontrol domainê wekî xelet mîheng kirî bibîne. Heke MX nederbasdar were dîtin domain neçalak dibe. Heke MX ji bo 3 kontrolên li pey hev nederbasdar bimîne API Key a girêdayî jî neçalak dibe. Heke paşê MX dîsa derbasdar bibe domain bixweber dîsa tê çalakkirin.

Domain

Mifteya giştî ya ceribandinê

Ji bo ceribandinê, mifteya giştî ya hevpar a li jêr tê nîşandan di sernivîsa X-API-Key de bişînin. Ew her roj diguhere û sînorê wê yê rojane 200.000 daxwaz e, ku di navbera hemû bikarhêneran de parvekirî ye.

Îro mayî

Di nûkirinê de

Kotaya zindî ji bo keya giştî tê barkirin...

Referansa API ya jêr dikare wekî Markdown ji bo amûrên AI, bingeha zanînê an README were kopîkirin.

Rasta BAZ: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Destpêka bilez

  • X-API-Key: YOUR_KEY vebijarka herî hêsan e. Ji bo ceribandinên bilez, li şûna YOUR_KEY mifteya giştî ya rojane ya li jor tê nîşandan bikar bînin.

  • Piraniya endpointên nameyê parametreya email dixwazin, mînak ?email=demo@example.com.

  • Bersivên API ya GPTMail JSON bi qadên success, data û error bikar tînin, û dema mifteya API tê bikaranîn usage jî tê de heye. Çewtiyên Cloudflare, di nav de bersivên sînorê rêjeyê, dibe ku li şûna wê HTML vegerînin. Berî parskirina JSON, rewşa HTTP û Content-Type kontrol bikin.

  • Heke berê domainek piştgirî ya niha li vê malperê dizanî, pêwîst nîne yekem endpointa çêkirina emailê bixwazî. Tu dikarî li herêmî prefix@domain çêkî û rasterast APIyên nameyê bixwazî, ev yek daxwaza API kêm dike.

Sînorên rêjeyê û dubarehewldan

  • GET û POST /api/generate-email ji bo her IP-ya çavkaniyê sînorekî hevpar ê 30 daxwazan di 10 saniyeyan de parve dikin. Ev hem ji bo mifteyên API yên giştî hem jî yên kesane derbasdar e. Mifte û klientên cuda yên li pişt heman IP-yê vî sînorî parve dikin.

  • Derbasbûna vî sînorî HTTP 429 vedigerîne û çêkirina navnîşanên e-nameyan ji bo 10 saniyeyan asteng dike. Berî dubarehewldanê, bi qasî dema Retry-After bisekinin. Heke ev sernivîs tune be, herî kêm 10 saniyeyan bisekinin, paşê bi navberên ku hêdî hêdî dirêjtir dibin dîsa biceribînin. Ji dubarehewldanên hevdem ên klientên ku heman IP parve dikin dûr bisekinin.

  • Ev qayde ji bo rêzkirina peyamên qutiyê an xwendina e-nameyên yek bi yek derbasdar nîne. Kotayên rojane û giştî yên mifteya API hîn jî bi serbixwe derbasdar in. Sekinîna 10 saniyeyan kotaya mifteyê ya qediyayî venagerîne.

Endpointên sereke

POST / GET
/api/generate-email

Peyamek demkî çêke. Ji bo herî hêsan a rêza inboxê ya ketoberî GET bikar bîne, an jî bi prefix û domain re POST dema ku kontrola eşkere dixwazî.

GET
/api/emails?email=...

Ji bo qutiyek nameyê email anîne.

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

Yek email anîne — di nav de nivîs, HTML, serîxaneyên xav û metadata.

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

Bi ID re yek email jê bibe.

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

Di qutiyek nameyê de hemû email jê bibe.

GET
/api/stats

Statîstîkên tevahiya malperê bixwîne.

Mînaka rêzê

Jêr du modelên hevpar in: bihêle servîs ji bo te inboxê çêke, an jî prefixeke sabît bixwaze. Heke berê domainek piştgirî dîtinî, dikarî li herêmî prefix@domain çêkî û rasterast bipirse.

1) Navnîşana emailê ya demkî ya ketoberî çêke

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Mînaka bersivê
{
  "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) Bi prefixeke sabît çêke (mînak 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"}'
Mînaka bersivê
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Emailên di inboxê de rêz bike

Heke domaina piştgirî dizanî, gavê 1 derbas bike û rasterast bipirse.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Mînaka bersivê
{
  "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) Yek email bixwîne — di nav de nivîsa sade, bedena HTML û metadata

EMAIL_ID bi id-ya ku ji gava 3 vegeriya biguherînin. Navnîşana qutiya e-nameyan jî wekî email bişînin (ji bo jêbirin û daxistina pêvekan jî): wê demê e-name rasterast ji qutiya xwe tê xwendin, li şûna ku li gorî ID were lêgerîn. Bi kilîta API parametreya email ne mecbûrî ye, lê şandina wê lêgerînê bileztir dike.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Mînaka bersivê
{
  "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) Bi ID re yek email jê bibe

Bi kilîta API parametreya email ne mecbûrî ye, lê şandina wê lêgerînê bileztir dike.

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

6) Tevahiya inboxê vala bike — hemû email ji bo vê navnîşanê jê dibe

Her bang komekê jê dibe. Heta ku bersiv "has_more": true dihewîne, dîsa bang bikin heta ku false vegerîne.

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

Şekla bersivê

Bersivên serkeftî bi gelemperî wiha dibin. Heke bi API Key re rastandî, bala xwe bidî agahdariya kotayê di usage de.

{
  "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
  }
}

Statîstîkên berfireh

  • /api/statistics/24h navbereke belavbûna saetî ya 24 saetan vedigerîne; ji bo navberên kevntir offset=1,2,... bikar bînin.
  • /api/statistics/top-subjects mijarên e-nameyan ên herî berbelav vedigerîne.
  • /api/statistics/top-domains domainên herî çalak vedigere.
  • /api/statistics/top-senders şandevanên herî çalak vedigere.
GPTMail