跳转至

二、接入流程

2.1 设置 Winmail 开放接口

要使用 Winmail 开放接口首先要设置 ApiKey和 ApiSecret,作为验证授权传递的参数。

用文本编辑器软件(例如 Notepad--)打开 ~\server\webmail\inc\config.apikey.php, 设置 ApiKey 和 ApiSecret, 出于安全考虑 Secret 长度必须不小于 20 个字符。 Winmail 6.6 以后版本,可以增加允许访问接口的来源 IP。

上图里有 2 个 ApiKey,一个没有限制访问的来源 IP,另外一个限制访问的来源 IP
注意:为了安全,请不用直接使用本文档和示例文件里的 ApiKey 和 ApiSecret

2.2 数据交互

1)构造请求参数:调用请求方根据 Winmail OpenAPI 提供的接口规则,通过程序生成得到签名结果及要传输给 API 平台的请求的数据结合;
2)发送请求数据:把构造完成的数据结合,通过 GET 或者 POST 提交的方式,传递给 Winmail OpenAPI 平台;
3)Winmail OpenAPI 平台对请求数据进行处理,会先进行安全校验等验证,一系列验证通过后便会处理完成本次发送过来的数据请求;
4)Winmail OpenAPI 平台把处理完成的结果数据按 JSON 格式,返回请求方;
5)请求方解析 JSON 结果后,可以结合自身的业务逻辑进行数据处理。