您的位置  > 互联网

API的概念(,应用程序编程接口)

API概念

API(应用程序编程接口)是一组预定义的函数,旨在为应用程序和开发人员提供访问基于软件或硬件的一组例程的能力,而无需访问源代码或了解内部细节工作。

API功能

API是一个定义明确的接口,为其他软件提供特定的服务

API 可以小到单个函数,也可以大到数百个类、方法、全局函数、数据类型、枚举类型、常量等。

API 实现可以是私有的或开源的

API分类

->面向对象语言API

示例:Java API 列表

->库和框架的API

示例:API,

API 和协议

示例:LDAP API

API和设备接口

示例:PC BIOS 调用接口、ASPI for SCSI 设备接口

网络应用程序接口

示例:地图API、新浪微博API、阿里云API市场

API请求和身份验证

API请求方式

GET:请求服务器获取资源

POST:请求服务器创建体验资源

PUT:请求服务器编辑或更新现有资源

:请求服务器删除资源

请求头和请求体

请求头()

提供了请求的元信息,它是一个简单的项目列表,包括客户端发送请求的时间、请求体的大小、身份验证等信息。

请求正文(Body)

包含客户端希望发送到服务器的数据

状态码-成功状态

调用成功后,除了返回的数据外,还会包含一个状态码,处理成功则返回2xx。 例如:200-好的

状态码-服务器错误代码

如果API调用不成功,将返回错误码。 服务器错误码为5xx,表示服务不可用(此时一般建议重试或联系产品页面的API服务商)

状态码-客户端错误代码

客户端错误码为4xx,业务错误。 这时一般会出现参数错误、签名错误、请求方式不正确、或者流控限制等业务错误。 建议详细检查错误代码并进行相应的解决。

返回数据格式 - JSON 或 XML

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

JSON数据格式表示方法

1. 表示对象:

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

2. 表示数组

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

API简单认证(方法)

您可以通过该方法对正在使用的接口进行身份认证,并获得访问相关API的调用权限。

指示:

请求中添加的字段;

配置字段的值为“+半角空格+值”

格式::值

例子:

API签名认证(&)

以及与当前账号等效的另一种账号密码机制。在云市场购买API后,可以找到对应的App Key和

API调试与调用

API调试

阿里云API市场提供在线调试功能,方便用户无需编写调用代码即可快速测试。 例如:IP地址查询

API调用步骤

获取API文档->创建应用->获取授权->调用API

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

API:你要调用的API,明确定义API参数

应用APP:作为您调用API时的身份,有用于验证您的身份

API与App之间的授权关系:App调用API需要有权限。 这个权限是通过授权函数来实现的。

->获取API文档

在云市场选择一个API,在API产品页面找到API使用文档。

成功购买API服务后,进入云市场管理控制台,您将看到所有已购买的API服务。 (如果尚未开通API网关服务,则同时开通API网关服务)

您可以跳转到API网关的控制台。 在已购买的API页面上,会显示所有已购买的API服务的列表,以及使用和付款的概览。

->创建应用程序

应用程序(APP)是调用API服务时的身份标识。 每个APP都有一组Key和密码,可以理解为账号和密码。 调用API时,需要传入用于签名计算的参数。 网关将验证这对密钥来验证您的身份。

您可以在API网管控制台的应用管理页面创建APP。 创建成功后,系统会为APP分配一个pair。

->获取授权

调用API