通用说明

为迈哈(MailHub)客户提供全面的接口，可供您实现各种自定义功能的开发。

coffee with coding...

准备工作

1. 开户

2. 获取开发者帐号{tenantId}与密钥{secretKey}

注意：

如果是平台“运营”，必须

如果是平台“商户”，请忽略

3. 获取接口网关基地址：https://mailhub.gateway.yiofong.com/


全局说明

通信协议基于TCP协议，必须使用 HTTPS且TLS版本为1.2及以上。

请求和响应均为JSON格式。因此需要为所有接口指定Accept和Content-Type报头，即：

Accept:application/json

Content-Type:application/json

接口中所有时间/日期类型的字段均以UTC+0时区，24小时制表示。

文档中关于接口参数示例，均不代表实际结果，仅说明相应格式。

请求谓词：

谓词适用场景（通常情况）
GET对某一资源进行“查询、搜索、获取”操作
POST“创建、新增、插入”某一资源
PUT“更新、更改/变更”某一资源下的相关信息
DELETE“删除”某一资源

响应状态码：

代码说明（通常情况）
20*请求已接收，接口已响应
30*服务端地址发生变更，需要重定向或更换接口地址
40*禁止访问或未授权、无权限被拒绝
50*发生错误；如：请求参数错误，服务端处理错误，服务器意外错误等

响应格式：

注意：后续所有接口响应参数均在此格式下。

名称类型必须说明
status数值是当前请求的响应状态码，与http状态码同步
message文本是当前请求的响应状态码的描述或说明
data*参考对应接口*参考对应接口为当前请求接口的响应正文

与具体接口响应主体相对应
timestamp数值是为当前请求接口的响应时间戳（Unix timestamp，毫秒）

响应200示例：

{    "status": 200,    "message": "ok",    "data": null, //referer interface    "timestamp": 1218154088000}

响应301/302示例：

{    "status": 301,    "message": "moved permanently",    "data": "https://example.com/path1/path2?x=a&y=1",    "timestamp": 1218154088000}

响应40x示例：

{    "status":401,    "message":"unauthorized",    "data":{        ...    },    "timestamp":1218154088000}

响应500示例：

{    "status":500,    "message":"error description",    "data":{        "traceId":"xxxyyyzzz",        "logId":1234567890,        "path":"/path1/path2",        "app":"YF.Gateway",        "sever":"USEDC1-UAT01",    },    "timestamp":1218154088000}

变更记录

[2021-06-06]v1.0.0初始发布。


使用声明

请务必保管好您的账户相关凭证，严禁提供给他人。

严禁通过相关接口实现违反约定或法律法规的功能。

请及时关注该文档，接口更新恕不另行通知。