ממשק API להעברת דוא"ל

תוכן עניינים

ספריות
בסיס URI
אימות
שגיאות
לוקליזציה
עימוד
חשבון
דומיינים
מזמין
חברים
- עדכן את חבר הדומיין
- הסר את חבר הדומיין
כינויים

ספריות

כרגע עדיין לא שחררנו עטיפות API, אבל אנחנו מתכננים לעשות זאת בעתיד הקרוב. שלח דואר אלקטרוני ל api@forwardemail.net אם ברצונך לקבל הודעה כאשר שוחרר מעטפת ה-API של שפת תכנות מסוימת. בינתיים, אתה יכול להשתמש בספריות בקשות HTTP המומלצות ביישום שלך, או פשוט להשתמש תלתל כמו בדוגמאות שלהלן.

שפה	ספריה
רובי	פאראדיי
פייתון	בקשות
ג'אווה	OkHttp
PHP	לפטפט
JavaScript	סופרגנט
Node.js	סופרגנט
ללכת	net / http
.NET	RestSharp

בסיס URI

נתיב ה-URI הבסיסי של HTTP הוא: https://api.forwardemail.net. נתיב ה-URI הבסיסי של HTTP של https://forwardemail.net:4000 הוצא משימוש החל מ-1 בינואר 2021.

אימות

כל נקודות הקצה דורשות שלך מפתח API להיות מוגדר כערך "שם משתמש" של הבקשה אישור בסיסי כּוֹתֶרֶת. אל תדאג - דוגמאות מסופקות להלן עבורך אם אינך בטוח מה זה.

שגיאות

אם מתרחשות שגיאות, גוף התגובה של בקשת ה- API יכיל הודעת שגיאה מפורטת.

קוד	שם
200	OK
400	בקשה רעה
401	לא מורשה
403	אסור
404	לא נמצא
429	יותר מדי בקשות
500	שגיאת שרת פנימית
501	לא מיושם
502	שער רע
503	שירותים לא זמינים
504	פסק זמן של שער

טיפ: אם אתה מקבל קוד סטטוס 5xx (מה שלא אמור לקרות), אנא צור איתנו קשר בכתובת api@forwardemail.net ואנו נעזור לך לפתור את הבעיה שלך באופן מיידי.

לוקליזציה

השירות שלנו מתורגם ליותר מ-25 שפות שונות. כל הודעות התגובה של ה-API מתורגמות למקום האחרון שזוהה של המשתמש שמבצע את בקשת ה-API. אתה יכול לעקוף זאת על ידי העברת מנהג Accept-Language כּוֹתֶרֶת. אל תהסס לנסות זאת באמצעות התפריט הנפתח של השפה בתחתית עמוד זה.

עימוד

אם ברצונך לקבל הודעה כאשר העימוד זמין, אנא שלח דוא"ל api@forwardemail.net.

חשבון

צור חשבון

POST /v1/account

פרמטר גוף	נדרש	סוג	תיאור
`email`	כן	מחרוזת (אימייל)	כתובת דוא"ל
`password`	כן	מחרוזת	סיסמה

בקשת דוגמה:

curl -X POST https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

אחזר חשבון

GET /v1/account

בקשת דוגמה:

curl -X GET https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

לעדכן חשבון

PUT /v1/account

פרמטר גוף	נדרש	סוג	תיאור
`email`	לא	מחרוזת (אימייל)	כתובת דוא"ל
`given_name`	לא	מחרוזת	שם פרטי
`family_name`	לא	מחרוזת	שם משפחה
`avatar_url`	לא	מחרוזת (URL)	קישור לתמונת אווטאר

בקשת דוגמה:

curl -X PUT https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

דומיינים

טיפ: נקודות קצה של דומיין עם שם דומיין /v1/domains/:domain_name מכיוון שהנתיב שלהם ניתנים להחלפה עם מזהה דומיין :domain_id. זה אומר שאתה יכול להתייחס לדומיין לפי אחד מהם name או id ערך.

רשימת תחומים

GET /v1/domains

פרמטר מחרוזת קווריסט	נדרש	סוג	תיאור
`name`	לא	מחרוזת (RegExp נתמך)	חפש דומיינים לפי שם
`alias`	לא	מחרוזת (RegExp נתמך)	חפש דומיינים לפי שם הכינוי
`recipient`	לא	מחרוזת (RegExp נתמך)	חפש דומיינים לפי הנמען

בקשת דוגמה:

curl -X GET https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

צור דומיין

POST /v1/domains

פרמטר גוף	נדרש	סוג	תיאור
`domain`	כן	מחרוזת (FQDN או IP)	שם תחום מוסמך לחלוטין ("FQDN") או כתובת IP
`plan`	לא	מחרוזת (אין ספור)	סוג התוכנית (חייב להיות `"free"`, `"enhanced_protection"`, או `"team"`, ברירת המחדל ל `"free"` או התוכנית הנוכחית בתשלום של המשתמש אם באחת)
`catchall`	לא	מחרוזת (כתובות דוא"ל תוחמות) או בוליאנית	צור כינוי תוסף ברירת מחדל, ברירת המחדל היא `true` (אם `true` הוא ישתמש בכתובת הדוא"ל של משתמש ה-API כנמען, ואם `false` לא ייווצר תכלס). אם מחרוזת עוברת, זוהי רשימה מופרדת של כתובות דוא"ל לשימוש כנמענים (מופרדות על ידי מעבר שורה, רווח ו/או פסיק)
`has_adult_content_protection`	לא	בוליאני	האם להפעיל הגנה על תוכן למבוגרים בדומיין זה
`has_phishing_protection`	לא	בוליאני	האם להפעיל הגנת דיוג של סורק דואר זבל בדומיין זה
`has_executable_protection`	לא	בוליאני	האם להפעיל הגנת הפעלה של סורק דואר זבל בדומיין זה
`has_virus_protection`	לא	בוליאני	האם להפעיל הגנה מפני וירוסים של סורק דואר זבל בדומיין זה
`has_recipient_verification`	לא	בוליאני	ברירת המחדל של הדומיין הגלובלי אם לדרוש ממקבלי הכינוי ללחוץ על קישור לאימות דוא"ל כדי שהודעות הדוא"ל יזרום

בקשת דוגמה:

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

אחזר דומיין

GET /v1/domains/example.com

בקשת דוגמה:

curl -X GET https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

אמת את רשומות הדומיין

GET /v1/domains/example.com/verify-records

בקשת דוגמה:

curl -X GET https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

עדכן תחום

PUT /v1/domains/example.com

פרמטר גוף	נדרש	סוג	תיאור
`smtp_port`	לא	מחרוזת או מספר	יציאה מותאמת אישית להגדרה עבור העברת SMTP (ברירת המחדל היא `"25"`)
`has_adult_content_protection`	לא	בוליאני	האם להפעיל הגנה על תוכן למבוגרים בדומיין זה
`has_phishing_protection`	לא	בוליאני	האם להפעיל הגנת דיוג של סורק דואר זבל בדומיין זה
`has_executable_protection`	לא	בוליאני	האם להפעיל הגנת הפעלה של סורק דואר זבל בדומיין זה
`has_virus_protection`	לא	בוליאני	האם להפעיל הגנה מפני וירוסים של סורק דואר זבל בדומיין זה
`has_recipient_verification`	לא	בוליאני	ברירת המחדל של הדומיין הגלובלי אם לדרוש ממקבלי הכינוי ללחוץ על קישור לאימות דוא"ל כדי שהודעות הדוא"ל יזרום

בקשת דוגמה:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

מחק דומיין

DELETE /v1/domains/:domain_name

בקשת דוגמה:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

מזמין

קבל הזמנה לדומיין

GET /v1/domains/:domain_name/invites

בקשת דוגמה:

curl -X GET https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

צור הזמנת דומיין

POST /v1/domains/example.com/invites

פרמטר גוף	נדרש	סוג	תיאור
`email`	כן	מחרוזת (אימייל)	כתובת דוא"ל להזמנה לרשימת חברי הדומיין
`group`	כן	מחרוזת (אין ספור)	קבוצה להוספה של המשתמש לחברות בדומיין איתה (יכול להיות אחד מהם `"admin"` או `"user"`)

בקשת דוגמה:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

הסר את ההזמנה לדומיין

DELETE /v1/domains/:domain_name/invites

פרמטר גוף	נדרש	סוג	תיאור
`email`	כן	מחרוזת (אימייל)	כתובת דוא"ל להסרה מרשימת חברי הדומיין

בקשת דוגמה:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

חברים

עדכן את חבר הדומיין

PUT /v1/domains/example.com/members/:member_id

פרמטר גוף	נדרש	סוג	תיאור
`group`	כן	מחרוזת (אין ספור)	קבוצה לעדכן את המשתמש לחברות בדומיין איתה (יכול להיות אחד `"admin"` או `"user"`)

בקשת דוגמה:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

הסר את חבר הדומיין

DELETE /v1/domains/:domain_name/members/:member_id

בקשת דוגמה:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

כינויים

רשום כינויים של דומיינים

GET /v1/domains/example.com/aliases

פרמטר מחרוזת קווריסט	נדרש	סוג	תיאור
`name`	לא	מחרוזת (RegExp נתמך)	חפש כינויים בדומיין לפי שם
`recipient`	לא	מחרוזת (RegExp נתמך)	חפש כינויים בדומיין לפי נמען

בקשת דוגמה:

curl -X GET https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

צור כינוי דומיין חדש

POST /v1/domains/example.com/aliases

פרמטר גוף	נדרש	סוג	תיאור
`name`	כן	מחרוזת	שם הכינוי
`recipients`	כן	מחרוזת או מערך	רשימת נמענים (חייבים להיות מופרדים בין מחרוזת שורה / רווח / פסיק או מערך של כתובות דוא"ל תקפות, שמות דומיין מלאים ("FQDN"), כתובות IP ו / או כתובות URL של רשת האינטרנט)
`description`	לא	מחרוזת	תיאור הכינוי
`labels`	לא	מחרוזת או מערך	רשימת התוויות (חייבת להיות מחרוזת או מערך מופרדים בפסקי שורות / רווח / פסיק)
`has_recipient_verification`	לא	בוליאני	האם לאפשר לדרוש מהנמענים ללחוץ על קישור לאימות דוא"ל כדי שהודעות הדוא"ל יזרמו (ברירת מחדל היא הגדרת הדומיין אם לא מוגדרת במפורש בגוף הבקשה)
`is_enabled`	לא	בוליאני	האם לאפשר להשבית כינוי זה (אם מושבת, דוא"ל ינותב לשום מקום אלא יחזיר קודי סטטוס מוצלחים)

בקשת דוגמה:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

אחזר את כינוי הדומיין

אתה יכול לאחזר כינוי דומיין לפי אחד מהם id או שלה name ערך.

GET /v1/domains/:domain_name/aliases/:alias_id

בקשת דוגמה:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

GET /v1/domains/:domain_name/aliases/:alias_name

בקשת דוגמה:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

עדכן כינוי דומיין

PUT /v1/domains/example.com/aliases/:alias_id

פרמטר גוף	נדרש	סוג	תיאור
`name`	לא	מחרוזת	שם הכינוי
`recipients`	כן	מחרוזת או מערך	רשימת נמענים (חייבים להיות מופרדים בין מחרוזת שורה / רווח / פסיק או מערך של כתובות דוא"ל תקפות, שמות דומיין מלאים ("FQDN"), כתובות IP ו / או כתובות URL של רשת האינטרנט)
`description`	לא	מחרוזת	תיאור הכינוי
`labels`	לא	מחרוזת או מערך	רשימת התוויות (חייבת להיות מחרוזת או מערך מופרדים בפסקי שורות / רווח / פסיק)
`has_recipient_verification`	לא	בוליאני	האם לאפשר לדרוש מהנמענים ללחוץ על קישור לאימות דוא"ל כדי שהודעות הדוא"ל יזרמו (ברירת מחדל היא הגדרת הדומיין אם לא מוגדרת במפורש בגוף הבקשה)
`is_enabled`	לא	בוליאני	האם לאפשר להשבית כינוי זה (אם מושבת, דוא"ל ינותב לשום מקום אלא יחזיר קודי סטטוס מוצלחים)

בקשת דוגמה:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

מחק כינוי דומיין

DELETE /v1/domains/:domain_name/aliases/:alias_id

בקשת דוגמה:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

זקוק למסמכים עם נתונים ומפתחות אמיתיים?

תיעוד API

ממשק API להעברת דוא"ל

תוכן עניינים

ספריות

בסיס URI

אימות

שגיאות

לוקליזציה

חשבון

צור חשבון

אחזר חשבון

לעדכן חשבון

דומיינים

רשימת תחומים

צור דומיין

אחזר דומיין

אמת את רשומות הדומיין

עדכן תחום

מחק דומיין

מזמין

קבל הזמנה לדומיין

צור הזמנת דומיין

הסר את ההזמנה לדומיין

חברים

עדכן את חבר הדומיין

הסר את חבר הדומיין

כינויים

רשום כינויים של דומיינים

צור כינוי דומיין חדש

אחזר את כינוי הדומיין

עדכן כינוי דומיין

מחק כינוי דומיין