ต้องการเอกสารที่มีข้อมูลและกุญแจจริงหรือไม่?
เพียงลงทะเบียนหรือเข้าสู่ระบบเพื่อให้คีย์ API ของคุณและข้อมูลบัญชีจริงปรากฏขึ้นด้านล่าง
เราได้สร้าง API สำหรับการเข้าถึงโดยทางโปรแกรมไปยังโดเมนนามแฝงและอื่น ๆ
เอกสาร API
การเข้าถึงข้อมูลของคุณแบบเป็นโปรแกรมAPI การส่งต่ออีเมล
สารบัญ
ห้องสมุด
ตอนนี้เรายังไม่ได้เปิดตัว wraps API แต่เราวางแผนที่จะทำในอนาคตอันใกล้ ส่งอีเมลไปที่api@forwardemail.net หากคุณต้องการรับการแจ้งเตือนเมื่อมีการปล่อย API wrapper ของภาษาโปรแกรมเฉพาะ ในขณะเดียวกันคุณสามารถใช้ไลบรารีคำขอ HTTP ที่แนะนำเหล่านี้ในแอปพลิเคชันของคุณหรือใช้ขด ดังในตัวอย่างด้านล่าง
ภาษา | ห้องสมุด |
---|---|
ทับทิม | ฟาราเดย์ |
หลาม | การร้องขอ |
ชวา | OkHttp |
PHP | ล่อ |
JavaScript | superagent |
โหนด js | superagent |
ไป | สุทธิ / http |
.สุทธิ | RestSharp |
URI ฐาน
เส้นทาง URI ฐาน HTTP ปัจจุบันคือ:https://api.forwardemail.net
. เส้นทาง HTTP พื้นฐาน URI ดั้งเดิมของhttps://forwardemail.net:4000
เลิกใช้งานแล้วเมื่อวันที่ 1 มกราคม 2021
การรับรอง
ปลายทางทั้งหมดต้องการของคุณรหัส API ฟรี : tada: กำหนดเป็นค่า "ชื่อผู้ใช้" ของคำขอการอนุญาตขั้นพื้นฐาน หัวข้อ. ไม่ต้องกังวล - มีตัวอย่างด้านล่างสำหรับคุณหากคุณไม่แน่ใจว่าสิ่งนี้คืออะไร
ข้อผิดพลาด
หากมีข้อผิดพลาดเกิดขึ้นเนื้อหาการตอบกลับของคำขอ API จะมีข้อความแสดงข้อผิดพลาดโดยละเอียด
รหัส | ชื่อ |
---|---|
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 |
ไม่ | สตริง (ที่อยู่อีเมลที่ใช้ตัวคั่น) หรือบูลีน | สร้างนามแฝง catch-all เริ่มต้นโดยค่าเริ่มต้นคือtrue (ถ้าtrue จะใช้ที่อยู่อีเมลของผู้ใช้ API เป็นผู้รับและถ้าfalse จะไม่มีการสร้าง catch-all) หากมีการส่งสตริงจะเป็นรายการที่อยู่อีเมลที่คั่นเพื่อใช้เป็นผู้รับ (คั่นด้วยตัวแบ่งบรรทัดเว้นวรรคและ / หรือลูกน้ำ) |
ตัวอย่างคำขอ:
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
พารามิเตอร์การสืบค้น | จำเป็นต้องใช้ | ชนิด | ลักษณะ |
---|---|---|---|
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 |
ไม่ | สตริงหรืออาร์เรย์ | รายการป้ายกำกับ (ต้องเป็นตัวแบ่งบรรทัด / ช่องว่าง / คั่นด้วยเครื่องหมายจุลภาคหรืออาร์เรย์) |
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 ของ webhook) |
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: