Ebiwandiiko bya API

API ya GPTMail

Kozesa GPTMail API okukola bbokisi za email ez'ekiseera, okulaga olukalala lw'obubaka n'okubusoma, n'okusazaamu email ng'oyita mu HTTPS ne header ya X-API-Key. Esaanira okugezesa okwekolako, emikutu gya CI/CD n'emirimu gya QA.

Engeri lw'okufuna 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

Ekyokulonda 2: Ongerako domain yo

Domain ey'olukale bw'eyita mu kukakasa MX: eweereddwayo nga toyingidde → ekisumuluzo kya API (okusaba 20000); eweereddwayo ng'oyingidde → obubonero 200. Buli domain efuna ekirabo kimu kyokka. Kikulu: bw'ekwatagana, ekiddako ky'ekika kifuuka ekiddako ky'oluntu eri abakozesa bonna ku mutimbagano guno, era abalala basobola okukola endagiriro z'ebisanduko wansi waakyo. Oluvannyuma lw'okukkiriza, togigyo, tokyusa, newakukyuusa rekodi ya MX eri eraga domain ku muweereza gwaffe. Ebirala, okwekenneenya oluvannyuma kulaba nga domain teri nnungi. Okwekenneenya nga kulaba MX nga si nnungi, domain ejjuzibwawo. MX bw'ekomekkereza okuba nga si nnungi mu 3 eziddirira, ne API Key enkolagana nayo ejjuzibwawo. MX bw'edda okuba ennungi oluvannyuma, domain ejjuzzibwawo mu kikafuu.

Domeyini

Ekisumuluzo ekya bonna eky'okugezesa

Okugezesa, sindika ekisumuluzo ekya bonna ekigabanyizibwa ekiragiddwa wansi mu header ya X-API-Key. Kikyuka buli lunaku era kirina ekkomo lya buli lunaku lya bisaba 200,000 abakozesa bonna bye bagabana.

Ekyasigaddewo ennaku eno

Kiddamu oluvannyuma lwa

Etteeka quota eri mu maaso ku musumari ogw'oluntu...

Ebikwata ku API wansi osobola okukopa nga Markdown eri ebikozesebwa bya AI, ebibanja by'amagezi, oba README.

URL ey'omusingi: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Otandika mu bwangu

  • X-API-Key: YOUR_KEY ky'ekkubo erisinga obwangu. Okugezesa amangu, kozesa ekisumuluzo ekya bonna ekya buli lunaku ekiragiddwa waggulu mu kifo kya YOUR_KEY.

  • Ebisinga ku nkomerero z'essanduko birina ekintu email, nga ekiddako ?email=demo@example.com.

  • Ebiddibwamu bya GPTMail API bikozesa JSON erimu ebifo success, data ne error, wamu ne usage ng'ekisumuluzo kya API kikozeseddwa. Ensobi za Cloudflare, nga mw'otwalidde ebiddibwamu by'ekkomo ly'obungi bw'ebisaba, ziyinza okukomyawo HTML mu kifo kya JSON. Kebera embeera ya HTTP ne Content-Type nga tonnasoma JSON.

  • Bw'omanya domain eri mu nkola ku mutimbagano guno, tosaba kulaba nkomerero y'okukola email okusooka. Osobola okukola prefix@domain ku kompyuta yo okuyita mu API z'essanduko butereevu, ekikuza okusaba kwa API kamu.

Ekkomo ly'obungi bw'ebisaba n'okuddamu okugezaako

  • GET ne POST /api/generate-email bigabana ekkomo ly'ebisaba 30 buli sikonda 10 ku buli IP gye biva. Kino kikola ku bisumuluzo bya API eby'olukale n'eby'obuntu. Ebisumuluzo n'abakozesa ab'enjawulo abali emabega wa IP y'emu bagabana ekkomo lino.

  • Okusukka ekkomo lino kukomyawo HTTP 429 era kuziyiza okukola endagiriro za email okumala sikonda 10. Lindako ebbanga eriragiddwa mu Retry-After nga tonnaddamu kugezaako. Header eno bw'eba teriiwo, lindako waakiri sikonda 10, oluvannyuma oddemu ogezeeko ng'ogenda wongera ku bbanga ly'olinda. Weewale okuddamu okugezaako omulundi gumu okuva mu bakozesa abagabana IP.

  • Etteeka lino terikwata ku kulaga lukalala lwa bbokisi oba okusoma email kinnoomu. Omugabo gwa buli lunaku n'omugabo gwonna ogw'ebisumuluzo bya API gikyakola nga gyetongodde. Okulinda sikonda 10 tekizzaawo mugabo gwa kisumuluzo oguweddewo.

Enkomerero ezikulu

POST / GET
/api/generate-email

Kola essanduku ly'email ery'ekiseera. Kozesa GET ku nkola entuufu, oba POST ne prefix ne domain bw'oba oyagala okukwata ku byonna mu lwatu.

GET
/api/emails?email=...

Funa email mu ssanduko.

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

Funa email emu, nga mulimu ebiwandiiko, HTML, emitwe egya butereevu, ne metadata.

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

Saza email emu ku ID.

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

Saza email zonna mu ssanduko.

GET
/api/stats

Soma ebibalvu by'omutimbagano gwonna.

Ekyokulabirako ky'engeri

Wansi mulimu empisa bbi ebikozesebwa: leka omusiri gwakole essanduko, oba saba prefix eteekeddwawo. Bw'omanya domain ey'omulekeddwa ku kiseera kino, osobola okukola essanduko ku kompyuta yo ofunze butereevu.

1) Kola endagiriro y'email ey'ekiseera eya mu bwangu

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Ekyokulabirako ky'eddamu
{
  "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) Kola nga prefix eteekeddwawo (okugeza 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"}'
Ekyokulabirako ky'eddamu
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Olukalala lw'email mu ssanduko

Bw'omanya domain eri mu nkola, buuka mutendera 1 ofunze butereevu.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Ekyokulabirako ky'eddamu
{
  "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 email emu — nga mulimu ebiwandiiko ebivaawo, omubiri gwa HTML, ne metadata

Kyusa EMAIL_ID ozzeewo id eyakomezeddwawo mu mutendera 3. Era sindika endagiriro ya bbokisi nga email (ne bw'oba osazaamu oba owanula ebigattiddwako): email olwo esomebwa butereevu okuva mu bbokisi yaayo mu kifo ky'okunoonyezebwa ku ID. Ng'olina ekisumuluzo kya API, parameter email teyeetaagisa, naye okugiweereza kwanguyiza okunoonya.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Ekyokulabirako ky'eddamu
{
  "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) Saza email emu ku ID

Ng'olina ekisumuluzo kya API, parameter email teyeetaagisa, naye okugiweereza kwanguyiza okunoonya.

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

6) Longoose ssanduko lyonna — saza email zonna ku ndagiriro eno

Buli kuyita kusangula ekibinja kimu. Bwe kiba nti eky'okuddamu kirimu "has_more": true, ddamu oyite okutuusa lwe kiddiza false.

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

Enkula y'eddamu

Eddamu eriri bulungi liri nga bwe lituuka bw'otyo. Bw'okwata omukutu nga API Key, kebera ebikwata ku quota munda mu 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
  }
}

Ebibalvu ebweddemu

  • /api/statistics/24h ekomyawo eddirisa limu erya ssaawa 24 ery'engabanya buli ssaawa; kozesa offset=1,2,... ku madirisa ag'edda.
  • /api/statistics/top-subjects ezzaawo emitwe gy'email egisinga okulabika.
  • /api/statistics/top-domains izzaawo ebyekika ebikozesebwa ennyo.
  • /api/statistics/top-senders izzaawo abasindikira abakozesa ennyo.
GPTMail