开发前准备工作

来自亿业科技接口
跳转至: 导航搜索

简介

开发前有如下准备工作:

  1. 申请开通接口权限
  2. 获取鉴权信息
  3. 获取必要的其他信息

不同的调用方式需要的工作内容不同,以下分别说明;


Webservice开发前准备工作

1)接口权限
默认开启,不需要准备;
2)鉴权信息
需要准备调用者账号和调用者接口密码
  1. 调用者账号:同人工登录账号名称;
  2. 调用者接口密码:和人工登录密码是不同的,需要额外设置;具体请参考本文下方的#接口密码说明
3)其他必要信息
如果用于发送邮件,需要准备相应的发送方和链接跟踪域名,并在平台验证通过;请参考本文下方的#发送方说明#链接跟踪域名说明

SMTP开发前准备工作

1)联系客服,报备发送场景并开通相应接口的权限
报备工作(请联系客服):报备您发送的场景(比如注册/激活/账单等),发送量和计划使用的发送方;
开通权限:报备审核通过后,我方会分配相应的资源并开启相应类别的SMTP权限(请参考本文下方的#SMTP权限说明);
 由于SMTP邮件是单封提交,无法人工审核,所以,我们需要您报备以预先分配相关的资源;
2)鉴权信息
需要准备调用者账号和调用者接口密码
  1. 调用者账号:同人工登录账号名称;
  2. 调用者接口密码:和人工登录密码是不同的,需要额外设置;具体请参考本文下方的#接口密码说明
3)其他必要信息
准备相应的发送方和链接跟踪域名,并在平台验证通过;请参考本文下方的#发送方说明#链接跟踪域名说明

Webhook开发前准备工作

1)接口权限
请联系我司客服开启Webhook接口权限;
2)鉴权信息
本接口属于被动式调用,不需要准备鉴权信息;
3)其他必要信息
需要配置我方推送的目的页面url;具体请参考本文下方的#Webhook配置


其他说明

接口密码说明

人员流动时,可能需要修改人工登录密码,为了不影响后台的接口发送,我司将接口密码和人工登录密码分开;
接口密码的设置请联系本公司管理员,请管理员登录平台后,通过编辑账号(我的配置->所有用户)的方式来设定接口密码;

发送方说明

我司发送邮件需要准备发送方,一般来说,本工作需要新建二级域名并添加合适的DNS记录;
请以调用者账号登录平台,打开"我的配置"=>"发送配置"下的"系统配置",点击"发送方地址"行后的"配置"进行操作即可;

链接跟踪域名说明

我司提供跟踪邮件的打开点击功能,但建议用户添加链接跟踪域名来实现;
请以调用者账号登录平台,打开"我的配置"=>"发送配置"下的"系统配置",点击"链接跟踪域名"行后的"配置"进行操作即可;

SMTP权限说明

为了方便管理,我司将事务类SMTP(对应27端口)和营销类SMTP(对应26端口)的权限分开;
如果您需要申请SMTP权限,请先确认您发送的邮件属于事务类还是营销类,或者两类都有;这两类定义如下;
  1. 事务类:账号/账单/交易相关邮件,比如:注册,激活,密码找回,账单,交易金额等邮件;
  2. 营销类:期刊资讯,产品促销,成员关怀类别的邮件
如果您仍然有疑问,请联系我方客服进行沟通;

Webhook配置

Webhoook需要配置相应的url;
请以调用者账号登录平台,打开"我的配置"=>"WebHook配置"进行操作即可;