Takardar API

GPTMail API

Yi amfani da API na GPTMail don ƙirƙirar akwatunan saƙo na wucin gadi, jera da karanta saƙonni, da goge imel ta HTTPS tare da kan X-API-Key. Ya dace da gwaje-gwajen atomatik, hanyoyin CI/CD, da ayyukan QA.

Yadda za a samu 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

Zaɓi 2: Ƙara domain ɗinku

Bayan yankin jama'a ya wuce tantancewar MX: an miƙa ba tare da shiga asusu ba → maɓallin API (buƙatu 20000); an miƙa bayan shiga → maki 200. Kowane yanki yana samun lada ɗaya kawai. Muhimmi: da zarar an haɗa, suffix na domain ɗin yana zama suffix na jama'a ga duk masu amfani, don haka wasu masu amfani kuma zasu iya ƙirƙirar adireshin akwatin a ƙarƙashinsa. Bayan kunna, kar ka share, ka maye, ko ka gyara rikodin MX wanda ke nuna domain zuwa sabis ɗinmu. In ba haka ba, binciken daga baya na iya ɗaukar domain a matsayin mara kyau. Idan bincike ya gano MX mara inganci, domain zai kashe. Idan MX ya ci gaba da kasancewa mara inganci a bincike 3 a jere, API Key mai alaƙa zai kashe kuma. Idan MX ya koma inganci daga baya, domain zai sake kunna atomatik.

Yankuna

Maɓallin gwaji na jama'a

Don gwaji, aika maɓallin jama'a da aka raba wanda aka nuna a ƙasa a cikin kan X-API-Key. Yana canzawa kowace rana kuma yana da iyakar buƙatu 200,000 a rana wadda duk masu amfani ke rabawa.

Ragowar yau

Sake saiti a cikin

Ana lodin kuota na kai tsaye don maɓallin jama'a...

Nassoshi na API a ƙasa za a iya kwafa su a matsayin Markdown don kayan AI, tushen ilimi, ko README.

URL ta asali: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Fara da sauri

  • X-API-Key: YOUR_KEY ita ce hanya mafi sauƙi. Don gwaje-gwaje cikin sauri, yi amfani da maɓallin jama'a na kullum da aka nuna a sama maimakon YOUR_KEY.

  • Yawancin endpoints na akwatin suna buƙatar sigar email, misali ?email=demo@example.com.

  • Amsoshin API na GPTMail suna amfani da JSON mai filayen success, data, da error, tare da usage idan an yi amfani da maɓallin API. Kurakuran Cloudflare, har da amsoshin iyakar yawan buƙatu, na iya dawo da HTML maimakon haka. Duba matsayin HTTP da Content-Type kafin fassara JSON.

  • Idan kun san domain da ake goyan baya yanzu a wannan shafin, ba dole ne ku kira endpoint na samar da imel da farko ba. Kuna iya haɗa prefix@domain a gida kuma kira API na akwatin kai tsaye, wanda yana adan wani buƙatar API ɗaya.

Iyakar yawan buƙatu da sake gwadawa

  • GET da POST /api/generate-email suna raba iyakar buƙatu 30 a cikin daƙiƙa 10 ga kowane adireshin IP na tushe. Wannan ya shafi maɓallan API na jama'a da na kai. Maɓallai da manhajoji daban-daban da ke bayan IP ɗaya suna raba wannan iyaka.

  • Wuce wannan iyaka yana dawo da HTTP 429 kuma yana toshe ƙirƙirar imel na daƙiƙa 10. Jira tsawon lokacin da Retry-After ya nuna kafin sake gwadawa. Idan babu wannan kan, jira aƙalla daƙiƙa 10, sannan ka sake gwadawa da tazara mai ƙaruwa. Ka guji sake gwadawa a lokaci ɗaya daga manhajojin da ke raba IP.

  • Wannan ƙa'ida ba ta shafi jera akwatin saƙo ko karanta imel ɗaya-ɗaya ba. Iyakokin yau da kullum da na jimilla na maɓallin API suna ci gaba da aiki daban. Jira daƙiƙa 10 ba ya dawo da iyakar maɓallin da ta ƙare.

Manyan endpoints

POST / GET
/api/generate-email

Ƙirƙiri akwatin wasiku na ɗan lokaci. Yi amfani da GET don mafi sauƙin hanyar akwatin bazuwar, ko POST tare da prefix da domain idan kana son sarƙaƙƙa.

GET
/api/emails?email=...

Samu imel don akwatin wasiku.

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

Samu ɗaya imel, gami da rubutu, HTML, kai orijinal, da metadata.

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

Share ɗaya imel ta ID.

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

Share dukkan imel a cikin akwatin wasiku.

GET
/api/stats

Karanta kididdiga na gaba ɗaya na shafin.

Misalin zance

A ƙasa akwai yanayi biyu na yau da kullun: bar sabis ya ƙirƙira akwatin, ko nemi prefix mai tsari. Idan kun san domain da ake goyan baya yanzu, kuna iya haɗa akwatin a gida kuma tambaya kai tsaye.

1) Ƙirƙiri adireshin imel na bazuwar na ɗan lokaci

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Misalin amsa
{
  "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) Ƙirƙiri da prefix mai tsari (misali 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"}'
Misalin amsa
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Jerin imel a cikin akwatin

Idan kun san domain da ake goyan baya, tsallake mataki 1 kuma ku tambaya kai tsaye.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Misalin amsa
{
  "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) Karanta ɗaya imel — ya haɗa rubutu mai sauƙi, jikin HTML, da metadata

Maye gurbin EMAIL_ID da id da aka dawo da shi daga mataki na 3. Haka kuma ku tura adireshin akwatin saƙo a matsayin email (har ma don gogewa da sauke haɗe-haɗe): sannan za a karanta imel ɗin kai tsaye daga akwatin saƙonsa maimakon a nema shi ta ID. Da maɓallin API, sigar email ba tilas ba ce, amma aika ta yana sa bincike ya yi sauri.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Misalin amsa
{
  "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) Share ɗaya imel ta ID

Da maɓallin API, sigar email ba tilas ba ce, amma aika ta yana sa bincike ya yi sauri.

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

6) Share duk akwatin — share duk imel ga wannan adireshi

Kowane kira yana goge rukuni ɗaya. Muddin amsar tana da "has_more": true, sake kira har sai ta dawo da false.

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

Siffar amsa

Amsoshin nasara galibi suna kama da haka. Idan an tabbatar da API Key, lura da bayanin kuota a cikin 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
  }
}

Ƙididdiga masu faɗi

  • /api/statistics/24h yana dawo da taga ɗaya na rarrabawa a kowace awa na awanni 24; yi amfani da offset=1,2,... don tagogin da suka gabata.
  • /api/statistics/top-subjects yana dawo da batutuwan imel da suka fi yawa.
  • /api/statistics/top-domains yana dawo da manyan domain.
  • /api/statistics/top-senders yana dawo da mafi aikatawa masu aika.
GPTMail