זקוק למסמכים עם נתונים ומפתחות אמיתיים?
כל שעליך לעשות הוא להירשם או להתחבר כדי לאכלס את מפתחות ה- API שלך ואת נתוני החשבון האמיתיים שלך למטה.
יצרנו ממשק API לגישה פרוגרמטית לדומיינים, כינויים ועוד.
תיעוד API
גישה תכנתית לנתונים שלךממשק API להעברת דוא"ל
תוכן עניינים
ספריות
כרגע עדיין לא פרסמנו עטיפות API, אך אנו מתכננים לעשות זאת בעתיד הקרוב. שלח דואר אלקטרוני לapi@forwardemail.net אם תרצה לקבל הודעה כאשר מתפרסם עטיפת ה- API של שפת תכנות מסוימת. בינתיים אתה יכול להשתמש בספריות אלה המומלצות לבקשות HTTP ביישום שלך, או פשוט להשתמשתלתל כמו בדוגמאות שלהלן.
שפה | ספריה |
---|---|
רובי | פאראדיי |
פייתון | בקשות |
ג'אווה | OkHttp |
PHP | לפטפט |
JavaScript | סופרגנט |
Node.js | סופרגנט |
ללכת | net / http |
.נֶטוֹ | RestSharp |
בסיס URI
נתיב ה- URI של בסיס ה- HTTP הנוכחי הוא:https://api.forwardemail.net
. נתיב ה- URI של בסיס HTTP מדור קודם שלhttps://forwardemail.net:4000
is deprecated as of January 1, 2021.
אימות
כל נקודות הקצה דורשות את שלךמפתח API בחינם - - 🎉 to be set as the "username" value of the request's אישור בסיסי כותרת. אל תדאג - להלן דוגמאות להלן אם אינך בטוח מה זה.
שגיאות
אם מתרחשות שגיאות, גוף התגובה של בקשת ה- API יכיל הודעת שגיאה מפורטת. מלבד ניסיון של למעלה מעשר שנים בכתיבת ממשקי API ותיעודם, קיבלו השראה מ-פס beautiful API documentation when we crafted ours 😄.
קוד | שם |
---|---|
200 | בסדר |
400 | בקשה רעה |
401 | לא מורשה |
403 | אסור |
404 | לא נמצא |
429 | יותר מדי בקשות |
500 | שגיאת שרת פנימית |
501 | לא מיושם |
502 | שער רע |
503 | שירותים לא זמינים |
504 | פסק זמן של שער |
לוקליזציה
השירות שלנו מתורגם ליותר מ 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
as their path are interchangeable with a domain's ID :domain_id
. This means you can refer to the domain by either its name
or id
value.
רשימת תחומים
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 לא ייווצר כל תופס). אם מחרוזת מועברת, זוהי רשימה מופרדת של כתובות דוא"ל לשימוש כמקבלים (מופרדים על ידי מעבר שורה, רווח ו / או פסיק) |
בקשת דוגמה:
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" ) |
בקשת דוגמה:
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
בקשת דוגמה:
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 |
לא | מחרוזת או מערך | רשימת התוויות (חייבת להיות מחרוזת או מערך מופרדים בפסקי שורות / רווח / פסיק) |
is_enabled |
לא | בוליאני | האם לאפשר להשבית כינוי זה (אם מושבת, דוא"ל ינותב לשום מקום אלא יחזיר קודי סטטוס מוצלחים) |
בקשת דוגמה:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
עדכן כינוי דומיין
PUT /v1/domains/example.com/aliases/:alias_id
פרמטר גוף | נדרש | סוג | תיאור |
---|---|---|---|
name |
לא | מחרוזת | שם הכינוי |
recipients |
כן | מחרוזת או מערך | רשימת נמענים (חייבים להיות מופרדים בין מחרוזת שורה / רווח / פסיק או מערך של כתובות דוא"ל תקפות, שמות דומיין מלאים ("FQDN"), כתובות IP ו / או כתובות URL של רשת האינטרנט) |
description |
לא | מחרוזת | תיאור הכינוי |
labels |
לא | מחרוזת או מערך | רשימת התוויות (חייבת להיות מחרוזת או מערך מופרדים בפסקי שורות / רווח / פסיק) |
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: