API დოკუმენტაცია

GPTMail API

გამოიყენეთ GPTMail API დროებითი საფოსტო ყუთების შესაქმნელად, წერილების სიის მისაღებად და წასაკითხად და ფოსტის წასაშლელად HTTPS-ით, X-API-Key სათაურით. ის განკუთვნილია ავტომატური ტესტებისთვის, CI/CD კონვეიერებისა და QA სამუშაო პროცესებისთვის.

როგორ მივიღოთ 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

ვარიანტი 2: დაამატეთ საკუთარი დომენი

საჯარო დომენის MX შემოწმების შემდეგ: ანგარიშში შესვლის გარეშე გაგზავნილი → API გასაღები (20000 მოთხოვნა); ანგარიშში შესვლისას გაგზავნილი → 200 ქულა. თითოეული დომენი მხოლოდ ერთ ჯილდოს იღებს. მნიშვნელოვანია: დაკავშირების შემდეგ ამ დომენის სუფიქსი ხდება საჯარო ყველა მომხმარებლისთვის, ამიტომ სხვებსაც შეუძლიათ მისამართების გენერაცია. აქტივაციის შემდეგ არ წაშალოთ, არ ჩაანაცვლოთ და არ შეცვალოთ MX ჩანაწერი, რომელიც დომენს ჩვენს სერვისზე მიუთითებს. წინააღმდეგ შემთხვევაში შემოწმებებმა შეიძლება დომენი არასწორად მიიჩნიონ. თუ MX არასწორია, დომენი გაითიშება. თუ MX 3 ზედიზედ შემოწმებაზე არასწორია, დაკავშირებული API Key-იც გაითიშება. თუ MX კვლავ სწორი გახდა, დომენი ავტომატურად ჩაირთვება.

დომენები

საჯარო სატესტო გასაღები

ტესტირებისთვის გაგზავნეთ ქვემოთ ნაჩვენები საერთო საჯარო გასაღები X-API-Key სათაურში. ის ყოველდღე იცვლება და აქვს 200 000 მოთხოვნის დღიური ლიმიტი, რომელიც ყველა მომხმარებელს შორის არის გაზიარებული.

დარჩენილი დღეს

განახლდება

იტვირთება საჯარო გასაღების ცოცხალი კვოტა...

ქვემოთ მოცემული API მითითება შეიძლება Markdown-ად დაიკოპიროს AI ინსტრუმენტების, ცოდნის ბაზების ან README-სთვის.

საბაზისო URL: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

სწრაფი დაწყება

  • X-API-Key: YOUR_KEY ყველაზე მარტივი ვარიანტია. სწრაფი ტესტებისთვის YOUR_KEY-ის ნაცვლად გამოიყენეთ ზემოთ ნაჩვენები ყოველდღიური საჯარო გასაღები.

  • საფოსტო ბოლო წერტილების უმეტესობას სჭირდება email პარამეტრი, მაგალითად ?email=demo@example.com.

  • GPTMail API-ის პასუხები იყენებს JSON-ს ველებით success, data და error, ხოლო API გასაღების გამოყენებისას ასევე usage-ით. Cloudflare-ის შეცდომებმა, მათ შორის სიხშირის ლიმიტის პასუხებმა, შეიძლება სანაცვლოდ HTML დააბრუნოს. JSON-ის დამუშავებამდე შეამოწმეთ HTTP სტატუსი და Content-Type.

  • თუ უკვე იცით მხარდაჭერილი დომენი, ჯერ წერილის გენერაციის გამოძახება არ გჭირდებათ. ლოკალურად შეკარით prefix@domain და პირდაპირ გამოიძახეთ საფოსტო API-ები — ერთი API request დაზოგავთ.

მოთხოვნების სიხშირის ლიმიტები და ხელახალი ცდები

  • GET და POST /api/generate-email იზიარებს ლიმიტს: 30 მოთხოვნა 10 წამში თითოეულ წყარო IP მისამართზე. ეს ეხება როგორც საჯარო, ისე პირად API გასაღებებს. ერთსა და იმავე IP-ს მიღმა მყოფი სხვადასხვა გასაღები და კლიენტი ამ ლიმიტს იზიარებს.

  • ამ ლიმიტის გადაჭარბებისას ბრუნდება HTTP 429 და მისამართების გენერირება 10 წამით იბლოკება. ხელახლა ცდამდე დაელოდეთ Retry-After-ში მითითებულ დროს. თუ ეს სათაური არ არის, დაელოდეთ მინიმუმ 10 წამს, შემდეგ კი სცადეთ ხელახლა თანდათან მზარდი პაუზებით. მოერიდეთ ერთსა და იმავე IP-ს მქონე კლიენტებიდან ერთდროულ ხელახალ ცდებს.

  • ეს წესი არ ეხება საფოსტო ყუთის წერილების სიის მიღებას ან ცალკეული წერილების წაკითხვას. API გასაღების დღიური და საერთო კვოტები კვლავ დამოუკიდებლად მოქმედებს. 10 წამის ლოდინი ამოწურულ გასაღების კვოტას ვერ აღადგენს.

ძირითადი ბოლო წერტილები

POST / GET
/api/generate-email

შექმენით დროებითი საფოსტო ყუთი. გამოიყენეთ GET ყველაზე მარტივი შემთხვევითი ნაკადისთვის, ან POST prefix-ით და domain-ით, როცა გჭირდებათ ცალსახა კონტროლი.

GET
/api/emails?email=...

მიიღეთ წერილები საფოსტო ყუთისთვის.

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

მიიღეთ ერთი წერილი — ტექსტი, HTML, ნედლი თავსართები და მეტამონაცემები.

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

წაშალეთ ერთი წერილი ID-ით.

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

წაშალეთ ყველა წერილი საფოსტო ყუთში.

GET
/api/stats

წაიკითხეთ მთელი საიტის სტატისტიკა.

მაგალითის ნაკადი

ქვემოთ ორი ხშირი მოდელია: სერვისმა შეგიქმნათ ყუთი, ან მოითხოვოთ ფიქსირებული პრეფიქსი. თუ უკვე იცით მხარდაჭერილი დომენი, შეგიძლიათ ლოკალურად შეკრათ მისამართი და პირდაპირ მოითხოვოთ.

1) შემთხვევითი დროებითი ელფოსტის მისამართის გენერაცია

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
პასუხის მაგალითი
{
  "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) გენერაცია ფიქსირებული პრეფიქსით (მაგ. 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"}'
პასუხის მაგალითი
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) წერილების სია საფოსტო ყუთში

თუ მხარდაჭერილი დომენი იცით, გამოტოვეთ ნაბიჯი 1 და პირდაპირ მოითხოვეთ.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
პასუხის მაგალითი
{
  "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) ერთი წერილის წაკითხვა — უბრალო ტექსტი, HTML სხეული და მეტამონაცემები

EMAIL_ID ჩაანაცვლეთ მე-3 ნაბიჯში დაბრუნებული id-ით. ასევე გადაეცით საფოსტო ყუთის მისამართი პარამეტრად email (წაშლისა და დანართების ჩამოტვირთვისას ასევე): მაშინ წერილი პირდაპირ თავისი საფოსტო ყუთიდან წაიკითხება და ID-ით ძებნა აღარ დასჭირდება. API გასაღებით email პარამეტრი არასავალდებულოა, მაგრამ მისი გაგზავნა ძიებას აჩქარებს.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
პასუხის მაგალითი
{
  "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) ერთი წერილის წაშლა ID-ით

API გასაღებით email პარამეტრი არასავალდებულოა, მაგრამ მისი გაგზავნა ძიებას აჩქარებს.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
პასუხის მაგალითი
{
  "success": true,
  "data": {
    "message": "Email deleted"
  }
}

6) მთელი ყუთის გასუფთავება — წაშლის ყველა წერილს ამ მისამართისთვის

ყოველი გამოძახება ერთ პაკეტს შლის. სანამ პასუხში "has_more": true არის, კვლავ გამოიძახეთ, სანამ false-ს არ დააბრუნებს.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/emails/clear?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
პასუხის მაგალითი
{
  "success": true,
  "data": {
    "message": "Deleted 3 emails",
    "count": 3,
    "has_more": false
  }
}

პასუხის სტრუქტურა

წარმატებული პასუხები ჩვეულებრივ ასე გამოიყურება. API Key-ით ავთენტიკაციისას ყურადღება მიაქციეთ 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
  }
}

გაფართოებული სტატისტიკა

  • /api/statistics/24h აბრუნებს ერთ 24-საათიან საათობრივი განაწილების ფანჯარას; ძველი ფანჯრებისთვის გამოიყენეთ offset=1,2,... პარამეტრი.
  • /api/statistics/top-subjects აბრუნებს ყველაზე ხშირ წერილის თემებს.
  • /api/statistics/top-domains აბრუნებს ყველაზე აქტიურ დომენებს.
  • /api/statistics/top-senders აბრუნებს ყველაზე აქტიურ გამომგზავნებს.
GPTMail