avatar

阿里云认证学习——调用API接口

阿里云大学,学习认证——Apsara Clouder专项技能认证:实现调用API接口

课时一

API概念

**API(Application Programming Interface,应用程序编程接口)**是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源代码或理解内部工作机制的细节。

API特点

  • API是一个明确定义的接口,可以为其他软件提供特定服务
  • API可以小到只包含一个单独的函数,也可以大到包含数以百计的类方法,全局函数,数据类型,枚举类型和常量等。
  • API的实现可以是私有的,也可以是开源的

API的分类

  1. 面向对象语言的API
    • 举例:Java API列表
  2. 库与框架的API
    • Windows API、Windows DirectX
  3. API与协议
    • 举例:LDAP应用程序接口
  4. API与接口设备
    • PC BIOS调用接口、ASPI for SCSI设备接口
  5. Web API
    • 举例:Google地图API、新浪微博API、阿里云API市场

为什么使用API

  1. 快速扩展功能
  2. 避免“造轮子”,提供开发效率
  3. 降低模块之间的耦合度

课时二

Web API协议及 HTTP请求

Web API一般采用HTTP作为底层协议,HTTP请求机制如下:

  1. 客户端向服务器请求发送一个请求
  2. 服务器给客户端一个响应,告诉客户端是否可以完成它请求的工作

HTTP请求包含的内容

为了构造有效的请求,客户端需要包含四个部分:

  • URL
  • 请求方式
  • Header
  • Body

API请求方式

请求方式发哦苏服务器客户端希望他采取什么动作。常见的请求方式有四种:

  • GET:请求服务器获取一个资源
  • POST:请求服务器创建一个新的资源
  • PUT:请求服务器编辑或更新一个已存在的资源
  • DELETE: 请求服务器删除一个资源

请求头与请求主体

请求头(Headers):提供了请求的元信息,是一个简单的项目列表,其中客户端发送请求的时间,和请求主体大小、身份认证等信息。

请求体(Body):包含了客户端希望发送给服务器的数据。

状态返回码

当成功调用API后,除了返回数据外,还会包含一个状态码,处理成功返回2xx:

API未调用成功,则返回错误代码。服务端错误代码是5xx,表示服务不可用(此时建议重试或联系商品页面的API服务商)

客户端错误代码为4xx,表示业务报错。此时一般为参数错误、签名错误、请求方式有误或被流控限制等业务类错误。建议详细查看错误码,针对性解决问题。

参考:错误代码表https://help.aliyun.com/document_detail/43906.html

API数据格式

返回数据格式

目前最新的API大多数使用JSON数据格式。JSON(JavaScript Object Notation)是一种轻量级的数据交换格式,采用完全独立于语言的文本格式,易于人阅读和编写,同时也易于机器解析和生成,是一种理想的数据交换语言。

JSON数据格式表示方法

  1. 表示对象

    JSON最常用的格式是对象的键值对

  2. 表示数组

    和普通的JS数组一样,JSON表示数据的方式是使用方括号[]

API身份证及签名认证

API简单身份认证(APPCODE)

可以通过APPCODE的方式,实现到被调用接口的身份认证,获取访问相关API的调用权限。

使用方法:

  • 请求Header中添加的Authorization子段;
  • 配置Authorization字段的值为“APPCODE + 半角空格 + APPCODE值”。

格式:

  • Authorization:APPCODE AppCode值

示例:

  • Authorization: APPCODE 3F2504E04F8911D39A0C0305E82C3301

API签名认证

AppKey和AppSecret相当于当前账户的另一套账号和密码机制。在云市场购买API后,就可以在控制台找到对应的AppKey和AppSecret。

具体的签名认证方法请参见请求头部字段请求签名说明文档

课时三

API调试

API调动步骤

graph LR A(获取API文档) -->B(创建应用) -->C(获取授权) -->D(调用API)

要调用API需要三个基础条件:

  • API:您即将要调用的API,明确API参数定义。
  • 应用app:作为您调用API时的身份,有AppKey和AppSecret用于验证您的身份。
  • API和App的权限关系:App想调用某个API需要具有API的权限,这个权限通过授权的功能来建立。

API调用注意事项

API调用的注意事项

  • 每个账号下APP个数上限为10个,APP名称应为账号下唯一。
  • 调用API的流控限制为,耽搁IP,QPS不超过100。
  • 你有权操作购买的API与APP的授权和解除授权。由于服务提供方授权给你的APP的API,你无权操作解除授权。
  • 你的请求需要包含签名信息,请参考文档请求签名说明文档。

课时四——实战

股票行情查询API说明

API查询数据包括行情,指标。分数线,K线,历史行情等,可批量查询沪深股市,香港股市。

开通股票行情查询API

在阿里云云市场API购买股票行情查询API,并查看代码请求方法及返回数据。查看自己的APPCODE或者AppKey和AppSecret。

其他,根据视频内容操作。

查看API文档

如有返回错误及更多需求,请查看API文档。

调用股票行情查询API

最后,考试成功

Author: Hui Ning
Link: https://angelni.github.io/API/
Copyright Notice: All articles in this blog are licensed under CC BY-NC-SA 4.0 unless stating additionally.
Donate
  • 微信
    微信
  • 支付宝
    支付宝

Comment