ApsaraClouder专项技能认证:实现调⽤API接⼝参考⽂档API简介
API的概念
API(Application Programming Interface , 应⽤程序编程接⼝)是⼀些预先定义的函数,⽬的是提供应⽤程序与开发⼈员基于某软件或硬件得以访问⼀组例程的能⼒,⽽⼜⽆需访问源码或理解内部⼯作机制的细节。
API的特点
API是⼀个明确定义的接⼝,可以为其他软件提供特定服务
API可以⼩到只包含⼀个函数,也可以⼤到包含数以百计的类、⽅法、全局函数、数据类型、枚举类型和常量等
API的实现可以是私有的,也可以是开源的
API的分类
⾯向对象语⾔的API 举例:JAVA API列表
库与框架的API 举例: Windows API、Windows DirectX
API与协议 举例: LDAP应⽤程序接⼝
API与设备接⼝ 举例: PC BIOS调⽤接⼝、ASPI for SCSI设备接⼝
Web API 举例: Google地图API、新浪微博API、阿⾥云API市场
为什么要使⽤API
快速扩展功能
避免“造轮⼦”,提⾼开发效率
降低模块之间的耦合度
API请求与认证
Web API 协议 及HTTP请求
Web API⼀般采⽤HTTP作为底层协议,HTTP请求机制如下:
客户端向服务器发送⼀个请求
服务器给客户端⼀个响应,告诉客户端是否可以完成它请求的⼯作。
URL(API调⽤地址)
请求⽅式
Headers(请求头)
Body(请求主体)
API请求⽅式
请求⽅式告诉服务器客户端希望它采取什么动作。常见的请求⽅式有四种:百度api接口
GET:请求服务器获取⼀个资源
POST:请求服务器创建⼀个新的资源
PUT:请求服务器编辑或更新⼀个已存在的资源
DELETE:请求服务器删除⼀个资源。
请求头(Headers):提供了请求的元信息,是⼀个简单的项⽬列表,其中有客户端发送请求的时间和请求主体⼤⼩、⾝份认证等信息。
请求体(Body) :包含了客户端希望发送给服务器的数据。
状态返回码
当成功调⽤API后,除了返回数据外,还会包含⼀个状态码,处理成功返回2xx
API未调⽤成功。则返回错误码。服务端错误码是5xx,表⽰服务不可⽤(此时⼀般建议重试或联系商品页⾯的API服务商)
客户端错误码为4xx,表⽰业务报错。此时⼀般为参数错误、签名错误、请求⽅式有误或被流控限制等业务类错误。建议详细查看错误码,针对性解决问题。
API数据格式
API⾝份认证及签名认证
API调⽤步骤
要调⽤API需要三个基础条件
API:您即将要调⽤的API,明确API参数定义。
应⽤app:作为您调⽤API时的⾝份,有AppKey和AppSecret⽤于验证您的⾝份。
API和App的权限关系:App想调⽤某个API需要具有该API的权限,这个权限通过授权的功能来建⽴。
API调⽤注意事项
每个账号下APP个数上限为10个,APP名称应为账号下唯⼀。
调⽤API的流控限制为,单个IP,QPS不超过100.
你有权操作购买的API与APP的授权和解除授权。由服务提供⽅授权给你的APP的API,你⽆权操作解除授权。
你的请求需要包含签名信息。
注:本⽂是作者考阿⾥云Apsara Clouder专项技能认证:实现调⽤API接⼝记录的。如果你想玩玩可以去阿⾥云调⽤API试试,感谢观看。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论