API请求与认证简介

API请求与认证

WebAPI协议

WebAPI基于http协议

工作原理

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

HTTP请求包含的内容

• URL（API调用地址）
• 请求方式
• Headers（请求头）
• Body（请求主体）

API请求方式

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

请求头与请求主体

1. 请求头

• 提供了请求的元信息，是一个简单的项目列表，其中有客户发送请求的时间和请求主体大小、身份认证等信息

2. 请求主体

• 包含了客户端希望发送给服务器的数据

状态码

1. 2XX表示请求成功
2. 5XX类型表示服务不可用
3. 4XX客户端错误码

返回数据格式

• JSON格式

JSON数据格式表示方法

1. 对象

• {“name”:“heilongjiang”}
• 多个值之间用逗号隔开

2. 数组

• [“name”：“黑龙江”]
• 多个值之间用逗号隔开

API简单身份认证

• Authorization放在请求头中
• 值为”APPCODE+半角空格+APPCODE值“

API签名认证

• APPKEY
• APPSECRET