通达信接口官网分享如何编写api接口?
1、接口概述
接口概要介绍了接口文件中所包含的商业功能,所针对的对象,以及接口文件中所包含的业务接口,使读者能够直观地了解。
2、权限描述
有些接口调用要求有权限验证,这里需要解释。如果接口仅仅是根据指定的token验证,那么文件需要解释如何获得token。如果一个接口需要验证一个签名,那么在此必须给出一个特定的签名方式。
3、编码方式
在接口的要求过程中,可能会因为编码而产生混乱的代码,因此,接口需要协商如何进行编码。
4、请求说明
接口文件的请求描述中,主要包括接口请求的域名和请求的数据格式接口清单,这些都是接口文件的主要内容。在要求参数时,需要指出每一个参数的含义、类型和是否必须的特性。在接口回应的结果中,还必须说明是否存在商业域。
5、状态代码描述
接口的反应通常包含一个响应状态代码,比如成功,失败等等。状态代码可以帮助访问者判定接口呼叫的状态。
通达信接口调用结果说明:
相关函数 |
调用结果 |
Deinit Logoff |
无 |
Init |
返回值为 授权成功的交易账户数量 |