Cần tài liệu với dữ liệu thực và khóa?
Chỉ cần đăng ký hoặc đăng nhập để có các khóa API và dữ liệu tài khoản thực được điền bên dưới.
Chúng tôi đã tạo một API để truy cập theo chương trình vào các tên miền, bí danh và hơn thế nữa.
Tài liệu API
Lập trình truy cập dữ liệu của bạnAPI chuyển tiếp email
Mục lục
- Thư viện
- URI cơ sở
- Xác thực
- Lỗi
- Bản địa hóa
- Phân trang
- Tài khoản
- Tên miền
- Mời
- Các thành viên
- Bí danh
Thư viện
Ngay bây giờ chúng tôi chưa phát hành bất kỳ trình bao bọc API nào, nhưng chúng tôi dự định sẽ làm như vậy trong tương lai gần. Gửi email đếnapi@ionaryemail.net nếu bạn muốn được thông báo khi trình bao bọc API của ngôn ngữ lập trình cụ thể được phát hành. Trong khi đó, bạn có thể sử dụng các thư viện yêu cầu HTTP được đề xuất này trong ứng dụng của mình hoặc chỉ cần sử dụngXoăn như trong các ví dụ dưới đây.
Ngôn ngữ | Thư viện |
---|---|
Hồng ngọc | Faraday |
Con trăn | yêu cầu |
Java | Được rồi |
PHP | ăn tham |
JavaScript | siêu tốc |
Node.js | siêu tốc |
Đi | mạng / http |
.MẠNG LƯỚI | RestSharp |
URI cơ sở
Đường dẫn URI cơ sở HTTP hiện tại là:https://api.forwardemail.net
. Đường dẫn URI cơ sở HTTP kế thừa củahttps://forwardemail.net:4000
is deprecated as of January 1, 2021.
Xác thực
Tất cả các điểm cuối yêu cầu của bạnkhóa API miễn phí 🎉 to be set as the "username" value of the request's Ủy quyền cơ bản tiêu đề. Đừng lo lắng - các ví dụ được cung cấp dưới đây cho bạn nếu bạn không chắc đây là gì.
Lỗi
Nếu có bất kỳ lỗi nào xảy ra, phần phản hồi của yêu cầu API sẽ chứa thông báo lỗi chi tiết. Bên cạnh việc có hơn mười năm kinh nghiệm viết API và ghi lại chúng, đã được truyền cảm hứng bởiSọc beautiful API documentation when we crafted ours 😄.
Mã | Tên |
---|---|
200 | đồng ý |
400 | Yêu cầu xấu |
401 | Không được phép |
403 | Cấm |
404 | Không tìm thấy |
429 | Quá nhiều yêu cầu |
500 | Lỗi máy chủ nội bộ |
501 | Không được thực hiện |
502 | Cổng xấu |
503 | dịch vụ Không sẵn có |
504 | Cổng Time-out |
Bản địa hóa
Dịch vụ của chúng tôi được dịch sang hơn 25 ngôn ngữ khác nhau. Tất cả các thông báo phản hồi API được dịch sang ngôn ngữ cuối cùng được phát hiện của người dùng thực hiện yêu cầu API. Bạn có thể ghi đè lên điều này bằng cách chuyển một tùy chỉnhAccept-Language
tiêu đề. Hãy dùng thử bằng cách sử dụng trình đơn thả xuống ngôn ngữ ở cuối trang này.
Phân trang
Nếu bạn muốn được thông báo khi phân trang có sẵn, xin vui lòng gửi emailapi@ionaryemail.net.
Tài khoản
Tạo tài khoản
POST /v1/account
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
email |
Đúng | Chuỗi (Email) | Địa chỉ email |
password |
Đúng | Chuỗi | Mật khẩu |
Yêu cầu ví dụ:
curl -X POST https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
Truy xuất tài khoản
GET /v1/account
Yêu cầu ví dụ:
curl -X GET https://api.forwardemail.net/v1/account \
-u API_TOKEN:
Cập nhật tài khoản
PUT /v1/account
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
email |
Không | Chuỗi (Email) | Địa chỉ email |
given_name |
Không | Chuỗi | Tên đầu tiên |
family_name |
Không | Chuỗi | Họ |
avatar_url |
Không | Chuỗi (URL) | Liên kết đến hình đại diện |
Yêu cầu ví dụ:
curl -X PUT https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
Tên miền
/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.
Liệt kê tên miền
GET /v1/domains
Tham số chuỗi truy vấn | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
name |
Không | Chuỗi (được hỗ trợ RegExp) | Tìm kiếm tên miền theo tên |
alias |
Không | Chuỗi (được hỗ trợ RegExp) | Tìm kiếm tên miền theo tên bí danh |
recipient |
Không | Chuỗi (được hỗ trợ RegExp) | Tìm kiếm tên miền theo người nhận |
Yêu cầu ví dụ:
curl -X GET https://api.forwardemail.net/v1/domains \
-u API_TOKEN:
Tạo tên miền
POST /v1/domains
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
domain |
Đúng | Chuỗi (FQDN hoặc IP) | Tên miền đủ điều kiện ("FQDN") hoặc địa chỉ IP |
plan |
Không | Chuỗi (liệt kê) | Loại kế hoạch (phải là"free" ,"enhanced_protection" , hoặc là"team" , mặc định là"free" ) |
catchall |
Không | Chuỗi (địa chỉ email được phân tách) hoặc Boolean | Tạo bí danh nhận toàn bộ thư mặc định, mặc định làtrue (nếutrue nó sẽ sử dụng địa chỉ email của người dùng API làm người nhận và nếufalse không có tất cả sẽ được tạo). Nếu một Chuỗi được chuyển, thì đó là danh sách địa chỉ email được phân tách để sử dụng làm người nhận (được phân tách bằng dấu ngắt dòng, dấu cách và / hoặc dấu phẩy) |
Yêu cầu ví dụ:
curl -X POST https://api.forwardemail.net/v1/domains \
-u API_TOKEN: \
-d domain=example.com \
-d plan=free
Lấy tên miền
GET /v1/domains/example.com
Yêu cầu ví dụ:
curl -X GET https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
Xác nhận hồ sơ tên miền
GET /v1/domains/example.com/verify-records
Yêu cầu ví dụ:
curl -X GET https://api.forwardemail.net/v1/domains/example.com/verify-records \
-u API_TOKEN:
Cập nhật tên miền
PUT /v1/domains/example.com
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
smtp_port |
Không | Chuỗi hoặc số | Cổng tùy chỉnh để định cấu hình cho chuyển tiếp SMTP (mặc định là"25" ) |
Yêu cầu ví dụ:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
Xóa tên miền
DELETE /v1/domains/:domain_name
Yêu cầu ví dụ:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
-u API_TOKEN:
Mời
Chấp nhận lời mời tên miền
GET /v1/domains/:domain_name/invites
Yêu cầu ví dụ:
curl -X GET https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
Tạo tên miền mời
POST /v1/domains/example.com/invites
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
email |
Đúng | Chuỗi (Email) | Địa chỉ email để mời vào danh sách thành viên tên miền |
group |
Đúng | Chuỗi (liệt kê) | Nhóm để thêm người dùng vào thành viên tên miền với (có thể là một trong"admin" hoặc là"user" ) |
Yêu cầu ví dụ:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
-u API_TOKEN: \
-d "email=user%40gmail.com" \
-d group=admin
Xóa tên miền mời
DELETE /v1/domains/:domain_name/invites
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
email |
Đúng | Chuỗi (Email) | Địa chỉ email để xóa khỏi danh sách thành viên tên miền |
Yêu cầu ví dụ:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
Các thành viên
Cập nhật thành viên tên miền
PUT /v1/domains/example.com/members/:member_id
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
group |
Đúng | Chuỗi (liệt kê) | Nhóm để cập nhật người dùng thành thành viên tên miền với (có thể là một trong"admin" hoặc là"user" ) |
Yêu cầu ví dụ:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
-u API_TOKEN:
Xóa thành viên tên miền
DELETE /v1/domains/:domain_name/members/:member_id
Yêu cầu ví dụ:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
-u API_TOKEN:
Bí danh
Lấy bí danh tên miền
GET /v1/domains/example.com/aliases
Yêu cầu ví dụ:
curl -X GET https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
Tạo bí danh tên miền mới
POST /v1/domains/example.com/aliases
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
name |
Đúng | Chuỗi | Tên bí danh |
recipients |
Đúng | Chuỗi hoặc mảng | Danh sách người nhận (phải là chuỗi ngắt dòng / dấu cách / dấu cách được phân tách bằng dấu phẩy hoặc Mảng địa chỉ email hợp lệ, tên miền đủ điều kiện ("FQDN"), địa chỉ IP và / hoặc URL của webhook) |
description |
Không | Chuỗi | Mô tả bí danh |
labels |
Không | Chuỗi hoặc mảng | Danh sách các nhãn (phải là chuỗi hoặc mảng được phân tách bằng dấu phẩy / dấu cách |
is_enabled |
Không | Boolean | Có bật hay không để tắt bí danh này (nếu bị tắt, email sẽ không được chuyển đến đâu nhưng trả về mã trạng thái thành công) |
Yêu cầu ví dụ:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
Cập nhật bí danh tên miền
PUT /v1/domains/example.com/aliases/:alias_id
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
name |
Không | Chuỗi | Tên bí danh |
recipients |
Đúng | Chuỗi hoặc mảng | Danh sách người nhận (phải là chuỗi ngắt dòng / dấu cách / dấu cách được phân tách bằng dấu phẩy hoặc Mảng địa chỉ email hợp lệ, tên miền đủ điều kiện ("FQDN"), địa chỉ IP và / hoặc URL của webhook) |
description |
Không | Chuỗi | Mô tả bí danh |
labels |
Không | Chuỗi hoặc mảng | Danh sách các nhãn (phải là chuỗi hoặc mảng được phân tách bằng dấu phẩy / dấu cách |
is_enabled |
Không | Boolean | Có bật hay không để tắt bí danh này (nếu bị tắt, email sẽ không được chuyển đến đâu nhưng trả về mã trạng thái thành công) |
Yêu cầu ví dụ:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
-u API_TOKEN:
Xóa bí danh tên miền
DELETE /v1/domains/:domain_name/aliases/:alias_id
Yêu cầu ví dụ:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
-u API_TOKEN: