API dokumentazioa

GPTMail APIa

Erabili GPTMail APIa aldi baterako sarrera-ontziak sortzeko, mezuak zerrendatu eta irakurtzeko eta posta ezabatzeko HTTPS bidez, X-API-Key goiburu batekin. Proba automatizatuetarako, CI/CD kanalizazioetarako eta QA lan-fluxuetarako egokia da.

Nola lortu API Key bat

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. aukera: Gehitu zure domeinua

Domeinu publikoak MX egiaztapena gainditzean: saioa hasi gabe bidalita → API gakoa (20000 eskaera); saioa hasita bidalita → 200 puntu. Domeinu bakoitzak sari bakarra jasotzen du. Garrantzitsua: konektatutakoan, domeinuaren atzizki hori gune honetako erabiltzaile guztientzako atzizki publikoa bihurtzen da, beraz besteek ere postontzi-helbideak sor ditzakete bere azpian. Aktibatu ondoren, ez ezabatu, ez ordeztu eta ez aldatu gure zerbitzura apuntatzen duen MX erregistroa. Bestela, egiaztapen berriek domeinua oker konfiguratuta jo dezakete. Egiaztapen batek MX erregistroa baliogabea badu, domeinua desaktibatuko da. MX erregistroa 3 egiaztapen jarraituetan baliogabea badago, lotutako API Keya ere desaktibatuko da. MX erregistroa berriro baliozkoa bada, domeinua berriro aktibatuko da automatikoki.

Domeinuak

Proba-gako publikoa

Probak egiteko, bidali behean erakusten den gako publiko partekatua X-API-Key goiburuan. Egunero aldatzen da, eta 200.000 eskaerako eguneko muga du, erabiltzaile guztien artean partekatua.

Gaur geratzen dena

Berrezartzea

Gako publikoaren kuota zuzena kargatzen...

Beheko API erreferentzia Markdown gisa kopiatu daiteke AI tresnetarako, ezagutza-basetarako edo README baterako.

Oinarrizko URLa: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Hasiera azkarra

  • X-API-Key: YOUR_KEY da aukerarik errazena. Proba azkarretarako, erabili goian erakutsitako eguneko gako publikoa YOUR_KEY balioaren ordez.

  • Postontzi amaiera-puntu gehienek email parametroa behar dute, adibidez ?email=demo@example.com.

  • GPTMail API-aren erantzunek JSON erabiltzen dute success, data eta error eremuekin, eta usage ere bai API gako bat erabiltzen denean. Cloudflare-ren erroreek, maiztasun-mugaren erantzunak barne, HTML itzul dezakete horren ordez. Egiaztatu HTTP egoera eta Content-Type JSON analizatu aurretik.

  • Gune honetan onartutako domeinu bat badakizu jadanik, ez duzu lehenik posta-sorkuntzaren amaiera-puntua deitu behar. prefix@domain lokalki osa dezakezu eta postontzi APIak zuzenean deitu, API request bat aurreztuz.

Eskaera-maiztasunaren mugak eta berriro saiatzea

  • GET eta POST /api/generate-email-ek muga bera partekatzen dute: 30 eskaera 10 segundoko jatorriko IP bakoitzeko. Hau API gako publiko zein pertsonalei aplikatzen zaie. IP beraren atzean dauden gako eta bezero desberdinek muga hau partekatzen dute.

  • Muga hau gainditzean HTTP 429 itzultzen da eta helbideak sortzea 10 segundoz blokeatzen da. Itxaron Retry-After-ek adierazitako denbora berriro saiatu aurretik. Goiburu hori ez badago, itxaron gutxienez 10 segundo eta saiatu berriro tarteak pixkanaka luzatuz. Saihestu IP bera partekatzen duten bezeroek aldi berean berriro saiatzea.

  • Arau hau ez zaie aplikatzen sarrera-ontziaren zerrendari edo mezu bakoitzaren irakurketari. API gakoen eguneko eta guztizko kuotek modu independentean aplikatzen jarraitzen dute. 10 segundo itxaroteak ez du agortutako gako-kuota berreskuratzen.

Oinarrizko amaiera-puntuak

POST / GET
/api/generate-email

Sortu behin-behineko sarrera-ontzia. Erabili GET ausazko sarrera-ontziaren fluxurik sinpleenerako, edo POST prefix eta domain erabiliz kontrol esplizitua nahi duzunean.

GET
/api/emails?email=...

Eskuratu postontzi baterako mezuak.

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

Eskuratu mezu bakarra, testua, HTML, goiburu gordinak eta metadatuak barne.

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

Ezabatu mezu bat IDaren arabera.

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

Ezabatu postontzi bateko mezu guztiak.

GET
/api/stats

Irakurri gune osoko estatistikak.

Fluxu adibidea

Behean bi eredu ohiko: utzi zerbitzuari sarrera-ontzia sortzen, edo eskatu aurrizki finkoa. Badakizu jadanik onartutako domeinu bat, postontzia lokalki osa dezakezu eta zuzenean kontsultatu.

1) Sortu ausazko helbide elektroniko behin-behinekoa

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Erantzun adibidea
{
  "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) Sortu aurrizki finkoarekin (adib. 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"}'
Erantzun adibidea
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Zerrendatu mezuak sarrera-ontzi batean

Onartutako domeinu bat badakizu, 1. urratsa saltatu eta kontsultatu zuzenean.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Erantzun adibidea
{
  "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) Irakurri mezu bakarra — testu laua, HTML gorputza eta metadatuak barne

Ordezkatu EMAIL_ID 3. urratsak itzulitako id batekin. Bidali sarrera-ontziaren helbidea email parametroan ere (baita ezabaketetan eta eranskinen deskargetan ere): horrela, mezua zuzenean bere sarrera-ontzitik irakurtzen da, IDaren bidez bilatu beharrean. API gako batekin email parametroa aukerakoa da, baina bidaltzeak bilaketa azkartzen du.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Erantzun adibidea
{
  "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) Ezabatu mezu bat IDaren arabera

API gako batekin email parametroa aukerakoa da, baina bidaltzeak bilaketa azkartzen du.

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

6) Garbitu sarrera-ontzi osoa — helbide honetako mezu guztiak ezabatzen ditu

Dei bakoitzak sorta bat ezabatzen du. Erantzunak "has_more": true duen bitartean, deitu berriro false itzultzen duen arte.

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

Erantzunaren egitura

Erantzun arrakastatsuak normalean horrelakoak dira. API Key batekin autentikatzen bazara, kontuan hartu usage barruko kuota-informazioa.

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

Estatistika zabalduak

  • /api/statistics/24h orduz orduko banaketa duen 24 orduko leiho bat itzultzen du; erabili offset=1,2,... leiho zaharragoetarako.
  • /api/statistics/top-subjects mezu-gai ohikoenak itzultzen ditu.
  • /api/statistics/top-domains domeinu aktiboenak itzultzen ditu.
  • /api/statistics/top-senders igorle aktiboenak itzultzen ditu.
GPTMail