תיעוד API

API של GPTMail

ה-API של GPTMail מאפשר ליצור תיבות דואר זמניות, להציג ולקרוא הודעות ולמחוק דואר באמצעות 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 נקודות. כל דומיין מקבל תגמול אחד בלבד. חשוב: לאחר החיבור, סיומת הדומיין הופכת ל-public suffix זמינה לכל המשתמשים באתר, ומשתמשים אחרים יכולים גם ליצור כתובות דואר תחתיה. לאחר ההפעלה, אל תמחק, תחליף או תשנה רשומת MX שמפנה את הדומיין לשירות שלנו — אחרת בדיקות מאוחרות עלולות לסווג את הדומיין כמוגדר לא נכון. אם בדיקה מאוחרת מוצאת MX לא תקין, הדומיין יושבת. אם ה-MX נשאר לא תקין ל-3 בדיקות רצופות, גם ה-API Key המשויך יושבת. אם ה-MX חוזר להיות תקין, הדומיין יופעל מחדש אוטומטית.

דומיינים

מפתח בדיקה ציבורי

לבדיקות, יש לשלוח את המפתח הציבורי המשותף המוצג למטה בכותרת X-API-Key. הוא מתחלף מדי יום ומוגבל ל-200,000 בקשות ביום, המשותפות לכל המשתמשים.

נותר להיום

יאופס בעוד

טוען מכסה חיה למפתח הציבורי...

ניתן להעתיק את מדריך ה-API למטה כ-Markdown לכלי AI, מאגרי ידע או README.

כתובת בסיס: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

התחלה מהירה

  • X-API-Key: YOUR_KEY היא האפשרות הפשוטה ביותר. לבדיקות מהירות, השתמשו במפתח הציבורי היומי המוצג למעלה במקום YOUR_KEY.

  • לרוב נקודות הקצה של תיבת הדואר נדרש פרמטר email, למשל ?email=demo@example.com.

  • תגובות ה-API של GPTMail משתמשות ב-JSON עם השדות success, data ו-error, ובנוסף usage כשמשתמשים במפתח API. שגיאות Cloudflare, כולל תגובות של מגבלת קצב, עשויות להחזיר HTML במקום זאת. בדקו את סטטוס ה-HTTP ואת ה-Content-Type לפני ניתוח JSON.

  • אם אתה כבר מכיר דומיין נתמך באתר, אין חובה לקרוא תחילה לנקודת יצירת הדואר. אפשר להרכיב prefix@domain מקומית לקרוא ישירות ל-APIs של תיבת הדואר — ולחסוך בקשת API אחת.

מגבלות קצב וניסיונות חוזרים

  • 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=...

מחיקת הודעת דואר אחת לפי מזהה.

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. העבירו גם את כתובת תיבת הדואר כפרמטר 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) מחיקת הודעה בודדת לפי מזהה

עם מפתח 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