Api 服务接口文档，API 接口规范文档

大雄 237 2022-07-10

支付系统接口

序号	接口地址	请求方式	说明
1	Pay/UnifiedOrder	POST	统一下单接口
2	Pay/OrderQuery	POST	查询订单该接口提供所有支付订单的查询，可以通过该接口主动查询订单状态，完成下一步的业务逻辑
3	Pay/OrderStatus	GET	查询订单状态该接口提供所有支付订单的状态查询，可以通过该接口主动查询订单状态，完成下一步的业务逻辑
4	Pay/Notify/Doc	POST	支付结果服务器异步通知如果调用 Pay/UnifiedOrder 时传递了 Notify 参数则使用该参数地址进行服务器异步 POST通知支付结果。返回 Code=SUCCESS 表示接收处理成功，否则将进入重试。支付系统发送给调用方
5	Pay/Return/Doc	GET	支付结果浏览器跳转同步通知如果调用 Pay/UnifiedOrder 时传递了 ReturnUrl 参数则使用该参数地址进行客户端浏览器自动跳转通知支付结果。参数通过 Get 方式传递，请通过 request.QueryString 获取注：该接口只是通知交易结束，具体信息需要请求查询订单接口获取具体信息，或者等待服务器异步通知。支付系统发送给调用方
6	Pay/Notify/Timer	POST	异步发送通知

更新内容：2009-05-12 Whois 查询增加注册信息显示
          2009-04-24 增加域名修改信息接口
          2008-11-24 增加域名 Whois 信息查询
          2008-11-24 正式启用API接口

说明：	API支持GET/POST方式，建议使用 POST 方式。
	所有POST数据必须使用 UTF-8 编码对数据进行 URLEncode
	除获取服务器时间外的其他接口，每次请求都需要进行身份验证。
	建议使用获取服务器时间接口来获得 vtime 值。

1、获取服务器时间接口
	URL地址：
		http://www.domain-api.com/api-get-time.html

	返回信息：
		<?xml version="1.0" encoding="utf-8" ?>
		<interface>
		<time>20080723153933</time>
		</interface>
	返回信息说明：
		time 值：14位时间值，用于身份验证的14位时间戳

2、身份验证方法
	URL地址：
		参见下列接口 URL 地址
	参数：
		username	用户名
		vtime		14位时间戳
		checksum	验证字串 = MD5(username + MD5(用户密码) + vtime)

2、域名查询接口
	GET/POST地址：
		http://www.domain-api.com/api-product-domain-query.html
	参数：
		domain		域名，如： abc.com,123.com,domain.cc 多个域名使用逗号间隔
	正常返回信息：
		<?xml version="1.0" encoding="utf-8" ?>
		<interface>
			<return_code><![CDATA[ 200 ]]></return_code>
			<return_msg><![CDATA[ 验证通过 ]]></return_msg>
			<check>
				<domain>abc.com</domain>
				<status>200</status>
				<msg>可以注册</msg>
			</check>
			<check>
				<domain>123.com</domain>
				<status>201</status>
				<msg>不可注册</msg>
			</check>
			<check>
				<domain>domain.cc</domain>
				<status>433</status>
				<msg>查询失败</msg>
			</check>
			<check>
				<domain>domain.aaa</domain>
				<status>500</status>
				<msg>错误的域名</msg>
			</check>
		</interface>
	异常返回信息：
		<?xml version="1.0" encoding="utf-8" ?> 
		<interface>
			<return_code><![CDATA[ 433 ]]></return_code>
			<return_msg><![CDATA[ 异常详细信息 ]]></return_msg>
		</interface>
	返回参数说明：
		return_code	返回状态代码，成功 = 200
		return_msg	返回详细提示信息
		domain = 域名
		status = 域名查询状态代码
			200 = 可以注册
			201 = 不可注册
			433 = 查询失败
			500 = 错误的域名
		msg = 详细说明

2、域名注册接口
	GET/POST地址：
		http://www.domain-api.com/api-product-domain-buy.html
	参数：
		domain		域名，如： abc.com
		year		注册年限（1-5）年
		dns1		主要DNS服务器		ns.dnsfamily.com
		dns2		备用DNS服务器		ns.cdnhost.cn
		dom_cn		域名所有者（中文）	成都世纪东方网络通信有限公司
		fn_cn		姓（中文）		小
		ln_cn		名（中文）		明
		country_cn	国家代码（中文）	中国
		provinces_cn	省份（中文）		四川
		city_cn		城市（中文）		成都
		address_cn	地址（中文）		成都市XXX

		dom_en		域名所有者（英文）	Oriental Century
		fn_en		姓（英文）		Xiao
		ln_en		名（英文）		Ming
		country_en	国家代码（英文）	CN
		provinces_en	省份（英文）		Sichuan
		city_en		城市（英文）		Chengdu
		address_en	地址（英文）		Chengdu City

		postcode	邮政编码		610041
		tel		电话号码		+86.02882001809
		fax		传真号码		+86.02882001809
		email		电子邮件		service@51web.com
	正常返回信息：
		<?xml version="1.0" encoding="utf-8" ?>
		<interface>
			<return_code><![CDATA[ 200 ]]></return_code>
			<return_msg><![CDATA[ 注册成功 ]]></return_msg>
		</interface>
	异常返回信息：
		<?xml version="1.0" encoding="utf-8" ?> 
		<interface>
			<return_code><![CDATA[ 433 ]]></return_code>
			<return_msg><![CDATA[ 异常详细信息 ]]></return_msg>
		</interface>
	返回参数说明：
		return_code	返回状态代码，成功 = 200
		return_msg	返回详细提示信息

3、域名续费接口
	GET/POST地址：
		http://www.domain-api.com/api-product-domain-renew.html
	参数：
		domain		域名，如： abc.com
		year		续费年限（1-5）年
		expiredate	域名当前过期日期，如：2008-01-01
	正常返回信息：
		<?xml version="1.0" encoding="utf-8" ?>
		<interface>
			<return_code><![CDATA[ 200 ]]></return_code>
			<return_msg><![CDATA[ 续费成功 ]]></return_msg>
		</interface>
	异常返回信息：
		<?xml version="1.0" encoding="utf-8" ?> 
		<interface>
			<return_code><![CDATA[ 433 ]]></return_code>
			<return_msg><![CDATA[ 异常详细信息 ]]></return_msg>
		</interface>
	返回参数说明：
		return_code	返回状态代码，成功 = 200
		return_msg	返回详细提示信息

4、获取域名信息接口
	GET/POST地址：
		http://www.domain-api.com/api-product-domain-view.html
	参数：
		domain		域名，如： abc.com
	正常返回信息：
		<?xml version="1.0" encoding="utf-8" ?>
		<interface>
			<return_code><![CDATA[ 200 ]]></return_code>
			<return_msg><![CDATA[ 验证通过 ]]></return_msg>

			<domain><![CDATA[ abc.com ]]></domain>
			<password><![CDATA[ 123456 ]]></password>
			<buydate><![CDATA[ 2008-01-01 ]]></buydate>
			<expiredate><![CDATA[ 2009-01-01 ]]></expiredate>
			<dns1><![CDATA[ ns1.abc.com ]]></dns1>
			<dns2><![CDATA[ ns2.abc.com ]]></dns2>

			<dom_en><![CDATA[ XX Company ]]></dom_en>
			<fn_en><![CDATA[ FirstName ]]></fn_en>
			<ln_en><![CDATA[ LastName ]]></ln_en>
			<country_en><![CDATA[ CN ]]></country_en>
			<provinces_en><![CDATA[ Beijing ]]></provinces_en>
			<city_en><![CDATA[ Beijing ]]></city_en>
			<address_en><![CDATA[ Beijing City ]]></address_en>

			<dom_cn><![CDATA[ 某某公司 ]]></dom_cn>
			<fn_cn><![CDATA[ 小 ]]></fn_cn>
			<ln_cn><![CDATA[ 李 ]]></ln_cn>
			<country_cn><![CDATA[ 中国 ]]></country_cn>
			<provinces_cn><![CDATA[ 北京 ]]></provinces_cn>
			<city_cn><![CDATA[ 北京 ]]></city_cn>
			<address_cn><![CDATA[ 北京 ]]></address_cn>

			<postcode><![CDATA[ 100000 ]]></postcode>
			<tel><![CDATA[ +86.01012345678 ]]></tel>
			<fax><![CDATA[ +86.01012345678 ]]></fax>
			<email><![CDATA[ support@abc.com ]]></email>
		</interface>
	异常返回信息：
		<?xml version="1.0" encoding="utf-8" ?> 
		<interface>
			<return_code><![CDATA[ 433 ]]></return_code>
			<return_msg><![CDATA[ 异常详细信息 ]]></return_msg>
		</interface>
	返回参数说明：
		return_code	返回状态代码，成功 = 200
		return_msg	返回详细提示信息

		domain		域名
		password	域名密码
		buydate		注册日期
		expiredate	过期日期
		dns1		主要DNS服务器
		dns2		备用DNS服务器

		dom_cn		域名所有者（中文）	成都世纪东方网络通信有限公司
		fn_cn		姓（中文）		小
		ln_cn		名（中文）		明
		country_cn	国家代码（中文）	中国
		provinces_cn	省份（中文）		四川
		city_cn		城市（中文）		成都
		address_cn	地址（中文）		成都市XXX

		dom_en		域名所有者（英文）	Oriental Century
		fn_en		姓（英文）		Xiao
		ln_en		名（英文）		Ming
		country_en	国家代码（英文）	CN
		provinces_en	省份（英文）		Sichuan
		city_en		城市（英文）		Chengdu
		address_en	地址（英文）		Chengdu City

		postcode	邮政编码		610041
		tel		电话号码		+86.02882001809
		fax		传真号码		+86.02882001809
		email		电子邮件		service@51web.com

5、域名修改DNS接口
	GET/POST地址：
		http://www.domain-api.com/api-product-domain-dns.html
	参数：
		domain		域名，如： abc.com
		dns1		主要DNS服务器地址，如：ns.dnsfamily.com
		dns2		备用DNS服务器地址，如：ns.cdnhost.cn
	正常返回信息：
		<?xml version="1.0" encoding="utf-8" ?>
		<interface>
			<return_code><![CDATA[ 200 ]]></return_code>
			<return_msg><![CDATA[ 修改成功 ]]></return_msg>
		</interface>
	异常返回信息：
		<?xml version="1.0" encoding="utf-8" ?> 
		<interface>
			<return_code><![CDATA[ 433 ]]></return_code>
			<return_msg><![CDATA[ 异常详细信息 ]]></return_msg>
		</interface>
	返回参数说明：
		return_code	返回状态代码，成功 = 200
		return_msg	返回详细提示信息

6、获取域名 Whois 信息接口
	GET/POST地址：
		http://www.domain-api.com/api-product-domain-whois.html
	参数：
		domain		域名，如： abc.com
	正常返回信息：
		<?xml version="1.0" encoding="utf-8" ?>
		<interface>
			<return_code><![CDATA[ 200 ]]></return_code>
			<return_msg><![CDATA[ 验证通过 ]]></return_msg>

			<whois><![CDATA[ Whois 信息 ]]></whois>
		</interface>
	异常返回信息：
		<?xml version="1.0" encoding="utf-8" ?> 
		<interface>
			<return_code><![CDATA[ 433 ]]></return_code>
			<return_msg><![CDATA[ 异常详细信息 ]]></return_msg>
		</interface>
	返回参数说明：
		return_code	返回状态代码，成功 = 200
		return_msg	返回详细提示信息

		whois		Whois 信息

7、域名修改信息接口
	GET/POST地址：
		http://www.domain-api.com/api-product-domain-info.html
	参数：
		domain		域名，如： abc.com

		fn_cn		姓（中文）		小
		ln_cn		名（中文）		明
		country_cn	国家代码（中文）	中国
		provinces_cn	省份（中文）		四川
		city_cn		城市（中文）		成都
		address_cn	地址（中文）		成都市XXX

		fn_en		姓（英文）		Xiao
		ln_en		名（英文）		Ming
		country_en	国家代码（英文）	CN
		provinces_en	省份（英文）		Sichuan
		city_en		城市（英文）		Chengdu
		address_en	地址（英文）		Chengdu City

		postcode	邮政编码		610041
		tel		电话号码		+86.02882001809
		fax		传真号码		+86.02882001809
		email		电子邮件		service@51web.com
	正常返回信息：
		<?xml version="1.0" encoding="utf-8" ?>
		<interface>
			<return_code><![CDATA[ 200 ]]></return_code>
			<return_msg><![CDATA[ 操作成功 ]]></return_msg>
		</interface>
	异常返回信息：
		<?xml version="1.0" encoding="utf-8" ?> 
		<interface>
			<return_code><![CDATA[ 433 ]]></return_code>
			<return_msg><![CDATA[ 异常详细信息 ]]></return_msg>
		</interface>
	返回参数说明：
		return_code	返回状态代码，成功 = 200
		return_msg	返回详细提示信息

==========================================================================
ASP例子：
<%
Set xmlhttp = Server.CreateObject("WinHttp.WinHttpRequest.5.1")
Set xmldom = Server.CreateObject("Microsoft.XMLDOM")
xmldom.Async = False
xmlhttp.SetTimeouts 30000,30000,30000,30000
xmlhttp.open "GET","http://www.domain-api.com/api-get-time.html",false
xmlhttp.send

xmldom.LoadXML(xmlhttp.responseText)
Set root = xmldom.documentElement
for i = 0 to root.childNodes.length - 1
	list = ucase(root.childNodes(i).nodeName)
	if list = "TIME" then
		strTime = root.childNodes(i).text
	end if
Next

response.write strTime
%>

标签：服务接口

发表评论

评论列表

Api 服务接口文档，API 接口规范文档

支付系统接口

推荐文章

接口调用是什么意思？几种常用接口调用方式

接口设计原则

8款在线 API 接口文档管理工具

api管理系统是什么？

什么是接口调试？接口调试的步骤有哪些？

api 接口管理系统有哪些？

接口测试有几种测试方法

API文档生成工具有哪些？

微服务和api网关区别

交换机配置步骤

最近发表

热评文章

在线接口文档管理工具推荐，支持在线测试，HTTP接口

开源的在线接口文档wiki工具Mindoc的介绍与使

如何优雅的进行接口设计？接口设计的六大原则是什么？

什么是API测试,api检测公司

软件接口设计怎么做？前后端分离软件接口设计思路

接口管理平台推荐，几大接口管理平台总有一款适合你！