ต้องการเอกสารที่มีข้อมูลและกุญแจจริงหรือไม่?

เพียงลงทะเบียนหรือเข้าสู่ระบบเพื่อให้คีย์ API ของคุณและข้อมูลบัญชีจริงปรากฏขึ้นด้านล่าง

คุณยอมรับ นโยบายความเป็นส่วนตัว และ ข้อกำหนด ของเรา

ไม่สนใจ? คลิกที่นี่เพื่ออ่านต่อ

สารบัญ

เราได้สร้าง API สำหรับการเข้าถึงโดยทางโปรแกรมไปยังโดเมนนามแฝงและอื่น ๆ

เอกสาร API

การเข้าถึงข้อมูลของคุณแบบเป็นโปรแกรม

API การส่งต่ออีเมล

สารบัญ

ห้องสมุด

ขณะนี้ เรายังไม่ได้เปิดตัว wrapper API ใดๆ แต่เราวางแผนที่จะดำเนินการดังกล่าวในอนาคตอันใกล้ ส่งอีเมล์ถึง api@forwardemail.net หากคุณต้องการได้รับแจ้งเมื่อมีการเผยแพร่ wrapper API ของภาษาโปรแกรมเฉพาะ ในระหว่างนี้ คุณสามารถใช้ไลบรารีคำขอ HTTP ที่แนะนำเหล่านี้ในแอปพลิเคชันของคุณ หรือเพียงแค่ใช้ ขด ดังตัวอย่างด้านล่าง

ภาษาห้องสมุด
ทับทิมฟาราเดย์
หลามการร้องขอ
ชวาOkHttp
PHPล่อ
JavaScriptsuperagent
โหนด jssuperagent
ไปสุทธิ / http
.NETRestSharp

URI ฐาน

เส้นทาง URI ฐาน HTTP ปัจจุบันคือ: https://api.forwardemail.net. เส้นทาง URI ฐาน HTTP ดั้งเดิมของ https://forwardemail.net:4000 เลิกใช้งานตั้งแต่วันที่ 1 มกราคม พ.ศ. 2564

การรับรอง

ปลายทางทั้งหมดต้องการของคุณ คีย์ API ที่จะกำหนดเป็นค่า "ชื่อผู้ใช้" ของคำขอของ การอนุญาตขั้นพื้นฐาน หัวข้อ. ไม่ต้องกังวล ตัวอย่างมีให้ด้านล่างหากคุณไม่แน่ใจว่านี่คืออะไร

ข้อผิดพลาด

หากมีข้อผิดพลาดเกิดขึ้นเนื้อหาการตอบกลับของคำขอ API จะมีข้อความแสดงข้อผิดพลาดโดยละเอียด

รหัสชื่อ
200OK
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 เนื่องจากเส้นทางของพวกเขาสามารถใช้แทนกันได้กับ ID ของโดเมน :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 จะไม่มีการสร้าง catch-all) หากส่งสตริง จะเป็นรายการที่อยู่อีเมลที่คั่นด้วยเพื่อใช้เป็นผู้รับ (คั่นด้วยตัวแบ่งบรรทัด เว้นวรรค และ/หรือเครื่องหมายจุลภาค)
has_adult_content_protectionไม่บูลีนจะเปิดใช้งานการป้องกันเนื้อหาสำหรับผู้ใหญ่ของ Spam Scanner ในโดเมนนี้หรือไม่
has_phishing_protectionไม่บูลีนจะเปิดใช้งานการป้องกันฟิชชิ่งของ Spam Scanner ในโดเมนนี้หรือไม่
has_executable_protectionไม่บูลีนจะเปิดใช้งานการป้องกันที่เรียกใช้งานได้ของ Spam Scanner ในโดเมนนี้หรือไม่
has_virus_protectionไม่บูลีนเปิดใช้งานการป้องกันไวรัส Spam Scanner ในโดเมนนี้หรือไม่
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ไม่บูลีนจะเปิดใช้งานการป้องกันเนื้อหาสำหรับผู้ใหญ่ของ Spam Scanner ในโดเมนนี้หรือไม่
has_phishing_protectionไม่บูลีนจะเปิดใช้งานการป้องกันฟิชชิ่งของ Spam Scanner ในโดเมนนี้หรือไม่
has_executable_protectionไม่บูลีนจะเปิดใช้งานการป้องกันที่เรียกใช้งานได้ของ Spam Scanner ในโดเมนนี้หรือไม่
has_virus_protectionไม่บูลีนเปิดใช้งานการป้องกันไวรัส Spam Scanner ในโดเมนนี้หรือไม่
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 ของ webhook)
descriptionไม่เชือกคำอธิบายนามแฝง
labelsไม่สตริงหรืออาร์เรย์รายการป้ายกำกับ (ต้องเป็นตัวแบ่งบรรทัด / ช่องว่าง / คั่นด้วยเครื่องหมายจุลภาคหรืออาร์เรย์)
has_recipient_verificationไม่บูลีนกำหนดให้ผู้รับต้องคลิกลิงก์ยืนยันอีเมลหรือไม่เพื่อให้อีเมลผ่านได้ (ค่าเริ่มต้นคือการตั้งค่าของโดเมน หากไม่ได้ตั้งค่าไว้อย่างชัดเจนในเนื้อหาคำขอ)
is_enabledไม่บูลีนไม่ว่าจะเปิดใช้งานเพื่อปิดใช้งานนามแฝงนี้หรือไม่ (หากปิดใช้งานอีเมลจะถูกส่งไปที่ใดก็ได้ แต่ส่งคืนรหัสสถานะสำเร็จ)

ตัวอย่างคำขอ:

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

เรียกชื่อแทนโดเมน

คุณสามารถเรียกชื่อแทนโดเมนโดย its 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 ของ webhook)
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: