欢迎使用西部数码域名API，您可以使用本文档介绍的 API 对域名进行相关操作。
1、使用限制：
1)、只有西部数码正式代理合作伙伴才能使用API功能。
2)、您需要提供正确的身份验证信息才能使用API功能，身份验证信息使用公共参数传递，关于身份验证详细信息详见 1.2节。
3)、API文档涉及我司API相关敏感信息，请勿随意传播。
2、服务地址：
https://api.west.cn/api/v2，仅支持HTTPS通道。
3、所有请求及返回数据均使用
GB2312/GBK进行编码。
4、
请合理使用api接口，注意请求频率，超限将在一定时间内暂停API权限。若通过api超高频率抢注过期域名，将被禁用API权限。
5、
请勿使用API接口来抢注过期域名，若短时间内重复提交相同域名尝试注册，会被禁用api权限。若需抢注域名，请访问：https://www.west.cn/services/grab/
6、
域名采用先完成身份信息核验再注册域名的注册方式。流程为：创建模板 → 提交实名资料 → 注册域名（传c_sysid）， 模板未通过实名前可用于注册域名，但域名无法解析使用，实名通过后会自动解除。
7、 因注册局未明确各个字段具体长度及格式，文档内相关提示仅供参考，具体以注册局判定为准
本节所述身份验证方式适用于除“4.10、上传域名实名资料”而外的所有API。（上传域名实名资料验证方式见4.10接口说明）
所有API均需要传递该身份认证参数，以便验证调用者身份，其中GET请求使用GET方式传递，POST请求使用POST方式传递，参数名称为token。
身份验证串有效期为10分钟。
身份验证参数token使用如下的方式生成：
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| token | string | 身份验证字符串，取值为：md5(username+api_password+timestamp)，其中： username：您在西部数码注册的用户名。 api_password：您设置的API密码。您可登录西部数码官网(https://www.west.cn)后台，在“代理商管理”->"API接口配置"页面查看您的api密码。 timestamp：当前时间的毫秒时间戳。 将字符串username与字符串api_password连接，再与timestamp连接，然后将生成的字符串进行md5求值，md5算法要求为： 32位16进制字符串，小写格式。 身份验证串有效期10分钟。 比如，您的西部数码用户名为：zhangsan，您的API密码为：5dh232kfg!* ,当前毫秒时间戳为：1554691950854，则： token = md5(zhangsan + 5dh232kfg!* + 1554691950854) = f17581fb2535b2a7ee4468eb3f96a2a9 |
本文档所涉及API（除"4.10 上传域名实名资料"外）在调用时均需要传递以下公共参数：
| 名称 | 类型 | 备注 |
|---|---|---|
| username | string | 用户名（接口使用者在西部数码注册的用户名） |
| time | number | 当前时间毫秒时间戳 |
| token | string | 身份验证串（请按 1.2节 说明生成） |
本文档所涉及API的数据返回均为JSON字符串格式，JSON数据结构如下表所示：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 |
|---|---|---|---|---|
| result | number | 必须 | 返回代码 200 成功 其它为失败 | |
| clientid | string | 必须 | 请求识别码 | |
| msg | string | 非必须 | 失败/成功返回的文本信息 | |
| errcode | number | 非必须 | 错误码（错误码含义详见 附录7.1 错误码说明） | |
| data | object | 非必须 | 成功返回数据(具体以各API返回数据说明为准) |
以下各API接口返回数据部分，除data字段各API不同外，其他字段均通用，后面各API返回信息中可能不再针对除data字段外的其它字段做特殊说明
本API系统不提供独立的API联调环境，调试环境与正式环境一致
接口调试时可以申请试用虚拟主机、.CN类域名、.com/.net类国际域名，这类域名注册后可以删除并退款。 而.hk/.tm/.info/.tv等特殊域名请勿测试，一旦注册将不能退款。
域名注册测试可以注册以.test结尾的域名，此类域名为测试域名不扣费。
如对本API文档有疑问，请联系邮箱 ：58851879@west.cn
请求地址： /info/?act=checkbalance
Method： GET
接口描述：
账号可用余额:(账号余额-冻结金额)=可用余额
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 返回值 | ||
| clientid | string | 必须 | |||
| data | object | 非必须 | |||
| ├─ balance | number | 非必须 | 账号余额 | ||
| ├─ freezemoney | number | 非必须 | 冻结金额 |