需要具有真实数据和密钥的文档吗?

只需注册或登录,即可在下面填充您的API密钥和真实帐户数据。

阅读我们的隐私政策条款

没兴趣?点击这里继续阅读

我们创建了一个API,用于以编程方式访问域,别名等。

🤖

API文档

以编程方式访问您的数据

电子邮件转发API

目录

图书馆

目前,我们尚未发布任何API包装器,但我们计划在不久的将来发布。发送电子邮件到api@forwardemail.net 如果您希望在发布特定编程语言的API包装器时收到通知。同时,您可以在应用程序中使用这些推荐的HTTP请求库,也可以简单地使用卷曲 如以下示例所示。

语言 图书馆
红宝石 法拉第
蟒蛇 要求
爪哇 OkHttp
的PHP uzz
的JavaScript 超级代理
Node.js 超级代理
网络/ http
。净 RestSharp

基本URI

当前的HTTP基本URI路径为:https://api.forwardemail.net。的旧式HTTP基本URI路径https://forwardemail.net:4000 将于2021年1月1日弃用。

认证方式

所有端点都要求您免费的API密钥 🎉设置为请求的“用户名”值基本授权 标头。不用担心-如果您不确定这是什么,请在下面为您提供示例。

失误

如果发生任何错误,API请求的响应主体将包含详细的错误消息。除了拥有超过十年的API编写和文档记录经验外,他的灵感还来自于条纹的 我们精心打造的API API文档。

名称
200
400 错误的请求
401 未经授权
403 禁止的
404 未找到
429 请求过多
500 内部服务器错误
501 未实现
502 错误的网关
503 暂停服务
504 网关超时
Tip: If you receive a 5xx status code (which should not happen), then please contact us at api@forwardemail.net and we will help you to resolve your issue immediately.

本土化

我们的服务被翻译成超过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"

Example Response:

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Password was invalid."
}

找回账户

GET /v1/account

请求示例:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid 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"

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

Tip: Domain endpoints with a domain's name /v1/domains/:domain_name as their path are interchangable 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:

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

建立网域

POST /v1/domains

身体参数 需要 类型 描述
domain 字符串(FQDN或IP) 完全限定的域名(“ FQDN”)或IP地址
plan 没有 字符串(可枚举) 计划类型(必须是"free""enhanced_protection", 要么"team",默认为"free"

请求示例:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

检索域

GET /v1/domains/example.com

请求示例:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid 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:

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid 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:

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid 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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

删除域邀请

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:

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

创建新的域别名

POST /v1/domains/example.com/aliases

身体参数 需要 类型 描述
name 别名
recipients 字符串或数组 收件人列表(必须用换行符/空格/逗号分隔,字符串或有效电子邮件地址,完全限定的域名(“ FQDN”),IP地址和/或Webhook URL的数组)
description 没有 别名说明
labels 没有 字符串或数组 标签列表(必须用换行符/空格/逗号分隔的字符串或数组)
is_enabled 没有 布尔型 是否启用以禁用此别名(如果禁用,则电子邮件将无处路由,但返回成功的状态代码)

请求示例:

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

Example Response:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API token."
}

更新域别名

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

身体参数 需要 类型 描述
name 没有 别名
recipients 字符串或数组 收件人列表(必须用换行符/空格/逗号分隔,字符串或有效电子邮件地址,完全限定的域名(“ FQDN”),IP地址和/或Webhook 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: