产品需要知道的API接口知识
一、什么是接口
API接口:一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。
系统对外发布的API地址:包含了IP、端口、API名称等信息。
数据传输规范:SKU只支持9位长度的字符串数据,库存只支持16位长度的数字,如果传参格式不对,那么就会启动反馈机制。
反馈机制:接口中的返回参数,为了保证对方能够正常获取所有的数据,不至于因为数据异常之类的原因导致数据丢失,在发现异常的时候,需要告知对方发生了什么异常,为什么无法获取到这个数据,对方就会根据这个反馈做出相应的调整,或者重新发起请求、或者放弃这种数据。
联调:两个开发者之间对着接口是否调用成功,数据能否正常获取。
二、接口类型有多少种
1. 根据响应的机制可以分为同步、异步接口:
同步接口:A系统请求B接口之后,不需要等待源系统返回结果就可以进行下一步操作。
异步接口:A系统请求B接口之后,需要等待源系统返回结果就可以进行下一步操作。
2. 根据接口的触发形式可以分为分发、订阅接口
分发接口:A系统产生新数据的时候就分发给B系统(也可以是多个)。
例如:电商网站后台的客户管理系统,在产生了一个新的黑名单客户的时候,就会将数据分发到订单、推荐等等各个系统,以便及时拦截这部分客户的订单。
订阅接口:B系统在需要的时候调用A系统的接口进行数据订阅。
三、一般接口包含以下几个内容:
接口地址
请求方法
请求参数
返回内容
错误代码
1)接口地址
顾名思义就是接口的地址,以网址的形式展现,你通过发送请求给这个网址来对接口进行交互操作。
2)请求方法
http传输形式最基本的方法有4种,分别是GET,POST,PUT,DELETE。我们可以这样认为:一个URL地址,它用于描述一个网络上的资源,而HTTP中的GET,POST,PUT,DELETE就对应着对这个资源的查,改,增,删4个操作。
而POST多余用对资源进行修改的操作。比如一般的天气查询,账号金额查询都以GET形式传输,比如登陆信息的传输就会用到POST。
以?分割URL和传输数据,参数之间以&相连,如果数据是英文字母/数字,原样发送,如果是空格,转换为+,如果是中文/其他字符,则直接把字符串用BASE64加密,
得出如:%E4%BD%A0%E5%A5%BD,其中%XX中的XX为该符号以16进制表示的ASCII。而POST把提交的数据则放置在是HTTP包的包体中。
请求参数
即传输参数的时候要带的一些参数,一般文档中会用表格的形式清晰的说明。当我向接口发送携带请求参数的请求时,都要携带什么字段,规则是什么。如下图:
返回内容
返回内容一般会以json或是XML的形式返回。